Type to search.

Update cases

Base URL
https://{kibana_url}
  • PATCH /api/cases
Auth

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.

Header parameters

kbn-xsrf string required

Cross-site request forgery protection

Request body

cases object[] · min items: 1 · max items: 100 required

An array containing one or more case objects.

category string · max length: 50

A word or phrase that categorizes the case.

closeReason union oneOf

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_positive duplicate true_positive benign_positive automated_closure other
connector union oneOf
One of:

Defines properties for connectors when type is .none.

type enum required

The type of connector. To create a case without a connector, use .none. To update a case to remove the connector, specify .none.

Values: .none
fields string required nullable

An object containing the connector fields. To create a case without a connector, specify null. To update a case to remove the connector, specify null.

id string required

The identifier for the connector. To create a case without a connector, use none. To update a case to remove the connector, specify none.

name string required

The name of the connector. To create a case without a connector, use none. To update a case to remove the connector, specify none.

description string · max length: 30000

The description for the case.

extended_fields map string to string · max properties: 500 The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Preview since 9.5 This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Case field values keyed by storage key. Keys follow the <field_name>_as_<storage_type> convention (for example priority_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
id string · max length: 30000 required

The identifier for the case.

severity enum

The severity of the case.

Values: critical high low medium
status enum

The status of the case.

Values: closed in-progress open
tags string[] · max items: 200

The words and phrases that help categorize cases. It can be an empty array.

title string · max length: 160

A title for the case.

version string required

The current version of the case. To determine this value, use the get case or search cases (_find) APIs.

Responses

Indicates a successful call.

application/json
<array> object[]
category string nullable

The case category.

closed_at string · format: date-time required nullable
closed_by object required nullable
email string required nullable
full_name string required nullable
profile_uid string
username string required nullable
comments union oneOf[] · max items: 10000 required

An array of comment objects for the case.

One of:
type enum required
Values: alert
alertId string[]
created_at string · format: date-time
id string
index string[]
owner enum

The application that owns the cases: Stack Management, Observability, or Elastic Security.

Values: cases observability securitySolution
pushed_at string · format: date-time nullable
updated_at string · format: date-time nullable
version string
connector union oneOf required
One of: (determined by type)
type: .none

Defines properties for connectors when type is .none.

type enum required

The type of connector. To create a case without a connector, use .none. To update a case to remove the connector, specify .none.

Values: .none
fields string required nullable

An object containing the connector fields. To create a case without a connector, specify null. To update a case to remove the connector, specify null.

id string required

The identifier for the connector. To create a case without a connector, use none. To update a case to remove the connector, specify none.

name string required

The name of the connector. To create a case without a connector, use none. To update a case to remove the connector, specify none.

created_at string · format: date-time required
created_by object required
email string required nullable
full_name string required nullable
profile_uid string
username string required nullable
description string required
duration integer required nullable

The elapsed time from the creation of the case to its closure (in seconds). If the case has not been closed, the duration is set to null. If the case was closed after less than half a second, the duration is rounded down to zero.

extended_fields map string to string The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Preview since 9.5 This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

The case's stored field values, keyed by storage key (for example priority_as_keyword).

external_service object required nullable
connector_id string
connector_name string
external_id string
external_title string
external_url string
pushed_at string · format: date-time
id string required
incremental_id integer nullable

A monotonically increasing number assigned to each case, unique per space. This value is generated asynchronously after the case is created and may not be present immediately in the response.

observables object[] required

Observables attached to the case.

createdAt string · format: date-time required

When the observable was created.

description string required nullable

An optional description for the observable.

id string required

The observable identifier.

typeKey string required

The observable type key.

updatedAt string · format: date-time required nullable

When the observable was last updated.

value string required

The observable value.

owner enum required

The application that owns the cases: Stack Management, Observability, or Elastic Security.

Values: cases observability securitySolution
settings object required

An object that contains the case settings.

extractObservables boolean

When true, observables (e.g. IPs, hashes, URLs) are automatically extracted from case comments. Optional; defaults to false when omitted.

syncAlerts boolean required

Turns alert syncing on or off.

severity enum required

The severity of the case.

Values: critical high low medium
status enum required

The status of the case.

Values: closed in-progress open
tags string[] required
title string required
total_observables integer required nullable

The number of observables attached to the case.

totalAlerts integer required
totalComment integer required
totalEvents integer

The number of events attached to the case.

updated_at string · format: date-time required nullable
updated_by object required nullable
email string required nullable
full_name string required nullable
profile_uid string
username string required nullable
version string required