IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Set case configuration API Update case comment API »

› › ›

Update cases API

edit

Update cases API

edit

Updates one or more cases.

For the most up-to-date API details, refer to the open API specification.

Request

edit

PATCH <kibana host>:<port>/api/cases

PATCH <kibana host>:<port>/s/<space_id>/api/cases

Prerequisites

edit

You must have all privileges for the Cases feature in the Management, Observability, or Security section of the Kibana feature privileges, depending on the owner of the cases you’re updating.

Path parameters

edit

<space_id>: (Optional, string) An identifier for the space. If it is not specified, the default space is used.

Request body

edit

cases

(Required, array of objects) Array containing one or more case objects.

Properties of cases objects

assignees

(Optional, array of objects) Array containing users that are assigned to the case.

Properties of assignee objects

uid: (Required, string) A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API.

connector

(Optional, object) An object that contains the connector configuration.

Properties of connector

fields

(Required, object) An object containing the connector fields. To remove the connector, specify null. If you want to omit any individual field, specify null as its value.

Properties of fields

For IBM Resilient connectors, specify:

issueTypes: (Required, array of strings) The issue types of the issue.
severityCode: (Required, string) The severity code of the issue.

For Jira connectors, specify:

issueType: (Required, string) The issue type of the issue.
parent: (Required, string) The key of the parent issue, when the issue type is Sub-task.
priority: (Required, string) The priority of the issue.

For ServiceNow ITSM connectors, specify:

category: (Required, string) The category of the incident.
impact: (Required, string) The effect an incident had on business.
severity: (Required, string) The severity of the incident.
subcategory: (Required, string) The subcategory of the incident.
urgency: (Required, string) The extent to which the incident resolution can be delayed.

For ServiceNow SecOps connectors, specify:

category: (Required, string) The category of the incident.
destIp: (Required, string) A comma separated list of destination IPs.
malwareHash: (Required, string) A comma separated list of malware hashes.
malwareUrl: (Required, string) A comma separated list of malware URLs.
priority: (Required, string) The priority of the incident.
sourceIp: (Required, string) A comma separated list of source IPs.
subcategory: (Required, string) The subcategory of the incident.

For Swimlane connectors, specify:

caseId: (Required, string) The identifier for the case.

For Webhook - Case Management connectors, specify null.

id

(Required, string) The identifier for the connector. To remove the connector, use none. To retrieve connector IDs, use Find connectors).

name

(Required, string) The name of the connector. To remove the connector, use none.

type

(Required, string) The type of the connector. Valid values are: .cases-webhook, .jira, .none, .resilient,.servicenow, .servicenow-sir, and .swimlane. To remove the connector, use .none.

description

(Optional, string) The updated case description.

id

(Required, string) The identifier for the case.

settings

(Optional, object) An object that contains the case settings.

Properties of settings

syncAlerts: (Required, boolean) Turn on or off synching with alerts.

severity

(Optional,string) The severity of the case. Valid values are: critical, high, low, and medium.

status

(Optional, string) The case status. Valid values are: closed, in-progress, and open.

tags

(Optional, string array) The words and phrases that help categorize cases.

title

(Optional, string) A title for the case.

version

(Required, string) The current version of the case. To determine this value, use Get case or Find cases.

Response codes

edit

200: Indicates a successful call.

Examples

edit

Update the description, tags, and connector of case ID a18b38a0-71b0-11ea-a0b2-c51ea50a58e2:

PATCH api/cases
{
  "cases": [
    {
      "id": "a18b38a0-71b0-11ea-a0b2-c51ea50a58e2",
      "version": "WzIzLDFd",
      "connector": {
        "id": "131d4448-abe0-4789-939d-8ef60680b498",
        "name": "My connector",
        "type": ".jira",
        "fields": {
          "issueType": "10006",
          "priority": null,
          "parent": null
        }
      },
      "description": "A new description.",
      "tags": [ "tag-1", "tag-2" ],
      "assignees": [],
      "settings": {
        "syncAlerts": true
      }
    }
  ]
}

The API returns the updated case with a new version value. For example:

[
  {
    "id": "66b9aa00-94fa-11ea-9f74-e7e108796192",
    "version": "WzU0OCwxXQ==",
    "comments": [],
    "totalComment": 0,
    "totalAlerts": 0,
    "title": "Case title 1",
    "tags": [ "tag-1", "tag-2" ],
    "settings": {
      "syncAlerts": true
    },
    "owner": "cases",
    "description": "A new description.",
    "duration": null,
    "severity": "low",
    "closed_at": null,
    "closed_by": null,
    "created_at": "2022-05-13T09:16:17.416Z",
    "created_by": {
      "email": null,
      "full_name": null,
      "username": "elastic"
    },
    "status": "open",
    "updated_at": "2022-05-13T09:48:33.043Z",
    "updated_by": {
      "email": null,
      "full_name": null,
      "username": "elastic"
    },
    "connector": {
      "id": "131d4448-abe0-4789-939d-8ef60680b498",
      "name": "My connector",
      "type": ".jira",
      "fields": {
        "issueType": "10006",
        "parent": null,
        "priority": null,
      }
    },
    "external_service": {
      "external_title": "IS-4",
      "pushed_by": {
        "full_name": null,
        "email": null,
        "username": "elastic"
      },
      "external_url": "https://hms.atlassian.net/browse/IS-4",
      "pushed_at": "2022-05-13T09:20:40.672Z",
      "connector_id": "05da469f-1fde-4058-99a3-91e4807e2de8",
      "external_id": "10003",
      "connector_name": "Jira"
    }
  }
]

« Set case configuration API Update case comment API »