Update cases
- Base URL
-
https://{kibana_url}
- PATCH /api/cases
- PATCH /s/{space_id}/api/cases
Refer to Spaces for more information.
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 case you're updating.
Request body
-
casesobject · min items: 1 · max items: 100required -
An array containing one or more case objects.
-
closeReasononeOf -
The close reason to sync to attached alerts when closing the case. Can be one of following predefined reasons: [false_positive, duplicate, true_positive, benign_positive, automated_closure, other] or a custom reason provided by the user.
-
Values:
false_positiveduplicatetrue_positivebenign_positiveautomated_closureother -
customFieldsobject · min items: 0 · max items: 10 -
Custom field values for a case. Any optional custom fields that are not specified in the request are set to null.
-
keystringrequired -
The unique identifier for the custom field. The key value must exist in the case configuration settings.
-
typerequired -
The custom field type. It must match the type specified in the case configuration settings.
-
Values:
texttoggle -
valuestring | booleanrequired nullable -
The custom field value. If the custom field is required, it cannot be explicitly set to null. However, for cases that existed when the required custom field was added, the default value stored in Elasticsearch is
undefined. The value returned in the API and user interface in this case isnull. -
extended_fieldsmap string to string · max properties: 500 -
Case field values keyed by storage key. Keys follow the
<field_name>_as_<storage_type>convention (for examplepriority_as_keyword) and map to the owner's global (library-wide) fields plus, when a template is applied to the case, that template's fields. On update, the keys provided are merged into the stored map; unlisted keys are left untouched. To discover the writable keys, use the get case fields API (GET /api/cases/fields). -
<string>string · max length: 30000 -
The words and phrases that help categorize cases. It can be an empty array.