+
Access
+
+ - APIKey KeyParamName:ApiKey KeyInQuery:false KeyInHeader:true
+ - HTTP Basic Authentication
+
+
+
+ [ Jump to
Models ]
+
+
Table of Contents
+
+
+
+
+
+
+
+
Up
+
post /s/{spaceId}/api/cases/{caseId}/comments
+
Adds a comment or alert to a case. (addCaseComment)
+
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 creating.
+
+
Path parameters
+
+
caseId (required)
+
+
Path Parameter — The identifier for the case. To retrieve case IDs, use the find cases API. All non-ASCII characters must be URL encoded. default: null
spaceId (required)
+
+
Path Parameter — An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. default: null
+
+
+
Consumes
+ This API call consumes the following media types via the request header:
+
+
+
Request body
+
+
+
+
Body Parameter —
+
+
+
+
Request headers
+
+
kbn-xsrf (required)
+
+
Header Parameter — default: null
+
+
+
+
+
+
Return type
+
+
+
+
+
Example data
+
Content-Type: application/json
+
{
+ "owner" : "cases",
+ "totalComment" : 0,
+ "settings" : {
+ "syncAlerts" : true
+ },
+ "totalAlerts" : 0,
+ "closed_at" : "2000-01-23T04:56:07.000+00:00",
+ "comments" : [ null, null ],
+ "created_at" : "2022-05-13T09:16:17.416Z",
+ "description" : "A case description.",
+ "title" : "Case title 1",
+ "created_by" : {
+ "full_name" : "full_name",
+ "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
+ "email" : "email",
+ "username" : "elastic"
+ },
+ "version" : "WzUzMiwxXQ==",
+ "closed_by" : {
+ "full_name" : "full_name",
+ "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
+ "email" : "email",
+ "username" : "elastic"
+ },
+ "tags" : [ "tag-1" ],
+ "duration" : 120,
+ "connector" : {
+ "name" : "none",
+ "id" : "none",
+ "fields" : {
+ "destIp" : "destIp",
+ "severity" : "severity",
+ "parent" : "parent",
+ "impact" : "impact",
+ "malwareUrl" : "malwareUrl",
+ "priority" : "priority",
+ "issueTypes" : [ 0.8008281904610115, 0.8008281904610115 ],
+ "issueType" : "issueType",
+ "sourceIp" : "sourceIp",
+ "urgency" : "urgency",
+ "malwareHash" : "malwareHash",
+ "caseId" : "caseId",
+ "severityCode" : 6.027456183070403,
+ "category" : "category",
+ "subcategory" : "subcategory"
+ },
+ "type" : ".none"
+ },
+ "updated_at" : "2000-01-23T04:56:07.000+00:00",
+ "updated_by" : {
+ "full_name" : "full_name",
+ "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
+ "email" : "email",
+ "username" : "elastic"
+ },
+ "id" : "66b9aa00-94fa-11ea-9f74-e7e108796192",
+ "external_service" : {
+ "external_title" : "external_title",
+ "pushed_by" : {
+ "full_name" : "full_name",
+ "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
+ "email" : "email",
+ "username" : "elastic"
+ },
+ "external_url" : "external_url",
+ "pushed_at" : "2000-01-23T04:56:07.000+00:00",
+ "connector_id" : "connector_id",
+ "external_id" : "external_id",
+ "connector_name" : "connector_name"
+ }
+}
+
+
Produces
+ This API call produces the following media types according to the request header;
+ the media type will be conveyed by the response header.
+
+
+
Responses
+
200
+ Indicates a successful call.
+
case_response_properties
+
+
+
+
+
Up
+
delete /s/{spaceId}/api/cases/{caseId}/comments
+
Deletes all comments and alerts from a case. (deleteCaseComments)
+
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 deleting.
+
+
Path parameters
+
+
caseId (required)
+
+
Path Parameter — The identifier for the case. To retrieve case IDs, use the find cases API. All non-ASCII characters must be URL encoded. default: null
spaceId (required)
+
+
Path Parameter — An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. default: null
+
+
+
+
+
Request headers
+
+
kbn-xsrf (required)
+
+
Header Parameter — default: null
+
+
+
+
+
+
+
+
+
+
+
Responses
+
204
+ Indicates a successful call.
+
+
+
+
+
+
Up
+
get /s/{spaceId}/api/cases/{caseId}/comments
+
Retrieves all the comments from a case. (getAllCaseComments)
+
You must have read privileges for the Cases feature in the Management, Observability, or Security section of the Kibana feature privileges, depending on the owner of the cases with the comments you're seeking.
+
+
Path parameters
+
+
caseId (required)
+
+
Path Parameter — The identifier for the case. To retrieve case IDs, use the find cases API. All non-ASCII characters must be URL encoded. default: null
spaceId (required)
+
+
Path Parameter — An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. default: null
+
+
+
+
+
+
+
+
Return type
+
+
+
+
+
Example data
+
Content-Type: application/json
+
{
+ "owner" : "cases",
+ "totalComment" : 0,
+ "settings" : {
+ "syncAlerts" : true
+ },
+ "totalAlerts" : 0,
+ "closed_at" : "2000-01-23T04:56:07.000+00:00",
+ "comments" : [ null, null ],
+ "created_at" : "2022-05-13T09:16:17.416Z",
+ "description" : "A case description.",
+ "title" : "Case title 1",
+ "created_by" : {
+ "full_name" : "full_name",
+ "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
+ "email" : "email",
+ "username" : "elastic"
+ },
+ "version" : "WzUzMiwxXQ==",
+ "closed_by" : {
+ "full_name" : "full_name",
+ "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
+ "email" : "email",
+ "username" : "elastic"
+ },
+ "tags" : [ "tag-1" ],
+ "duration" : 120,
+ "connector" : {
+ "name" : "none",
+ "id" : "none",
+ "fields" : {
+ "destIp" : "destIp",
+ "severity" : "severity",
+ "parent" : "parent",
+ "impact" : "impact",
+ "malwareUrl" : "malwareUrl",
+ "priority" : "priority",
+ "issueTypes" : [ 0.8008281904610115, 0.8008281904610115 ],
+ "issueType" : "issueType",
+ "sourceIp" : "sourceIp",
+ "urgency" : "urgency",
+ "malwareHash" : "malwareHash",
+ "caseId" : "caseId",
+ "severityCode" : 6.027456183070403,
+ "category" : "category",
+ "subcategory" : "subcategory"
+ },
+ "type" : ".none"
+ },
+ "updated_at" : "2000-01-23T04:56:07.000+00:00",
+ "updated_by" : {
+ "full_name" : "full_name",
+ "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
+ "email" : "email",
+ "username" : "elastic"
+ },
+ "id" : "66b9aa00-94fa-11ea-9f74-e7e108796192",
+ "external_service" : {
+ "external_title" : "external_title",
+ "pushed_by" : {
+ "full_name" : "full_name",
+ "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
+ "email" : "email",
+ "username" : "elastic"
+ },
+ "external_url" : "external_url",
+ "pushed_at" : "2000-01-23T04:56:07.000+00:00",
+ "connector_id" : "connector_id",
+ "external_id" : "external_id",
+ "connector_name" : "connector_name"
+ }
+}
+
+
Produces
+ This API call produces the following media types according to the request header;
+ the media type will be conveyed by the response header.
+
+
+
Responses
+
200
+ Indicates a successful call.
+
case_response_properties
+
+
+
+
+
Up
+
patch /s/{spaceId}/api/cases/{caseId}/comments
+
Updates a comment or alert in a case. (updateCaseComment)
+
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. NOTE: You cannot change the comment type or the owner of a comment.
+
+
Path parameters
+
+
caseId (required)
+
+
Path Parameter — The identifier for the case. To retrieve case IDs, use the find cases API. All non-ASCII characters must be URL encoded. default: null
spaceId (required)
+
+
Path Parameter — An identifier for the space. If /s/ and the identifier are omitted from the path, the default space is used. default: null
+
+
+
Consumes
+ This API call consumes the following media types via the request header:
+
+
+
Request body
+
+
+
+
Body Parameter —
+
+
+
+
Request headers
+
+
kbn-xsrf (required)
+
+
Header Parameter — default: null
+
+
+
+
+
+
Return type
+
+
+
+
+
Example data
+
Content-Type: application/json
+
{
+ "owner" : "cases",
+ "totalComment" : 0,
+ "settings" : {
+ "syncAlerts" : true
+ },
+ "totalAlerts" : 0,
+ "closed_at" : "2000-01-23T04:56:07.000+00:00",
+ "comments" : [ null, null ],
+ "created_at" : "2022-05-13T09:16:17.416Z",
+ "description" : "A case description.",
+ "title" : "Case title 1",
+ "created_by" : {
+ "full_name" : "full_name",
+ "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
+ "email" : "email",
+ "username" : "elastic"
+ },
+ "version" : "WzUzMiwxXQ==",
+ "closed_by" : {
+ "full_name" : "full_name",
+ "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
+ "email" : "email",
+ "username" : "elastic"
+ },
+ "tags" : [ "tag-1" ],
+ "duration" : 120,
+ "connector" : {
+ "name" : "none",
+ "id" : "none",
+ "fields" : {
+ "destIp" : "destIp",
+ "severity" : "severity",
+ "parent" : "parent",
+ "impact" : "impact",
+ "malwareUrl" : "malwareUrl",
+ "priority" : "priority",
+ "issueTypes" : [ 0.8008281904610115, 0.8008281904610115 ],
+ "issueType" : "issueType",
+ "sourceIp" : "sourceIp",
+ "urgency" : "urgency",
+ "malwareHash" : "malwareHash",
+ "caseId" : "caseId",
+ "severityCode" : 6.027456183070403,
+ "category" : "category",
+ "subcategory" : "subcategory"
+ },
+ "type" : ".none"
+ },
+ "updated_at" : "2000-01-23T04:56:07.000+00:00",
+ "updated_by" : {
+ "full_name" : "full_name",
+ "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
+ "email" : "email",
+ "username" : "elastic"
+ },
+ "id" : "66b9aa00-94fa-11ea-9f74-e7e108796192",
+ "external_service" : {
+ "external_title" : "external_title",
+ "pushed_by" : {
+ "full_name" : "full_name",
+ "profile_uid" : "u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0",
+ "email" : "email",
+ "username" : "elastic"
+ },
+ "external_url" : "external_url",
+ "pushed_at" : "2000-01-23T04:56:07.000+00:00",
+ "connector_id" : "connector_id",
+ "external_id" : "external_id",
+ "connector_name" : "connector_name"
+ }
+}
+
+
Produces
+ This API call produces the following media types according to the request header;
+ the media type will be conveyed by the response header.
+
+
+
Responses
+
200
+ Indicates a successful call.
+
case_response_properties
+
+
+
+
+ [ Jump to
Methods ]
+
+
Table of Contents
+
+ Case_response_properties_for_comments_inner - Case_response_properties_for_connectors - Case response properties for connectorsadd_alert_comment_request_properties - Add case comment request properties for alertsadd_case_comment_request - Add case comment requestadd_user_comment_request_properties - Add case comment request properties for user commentsalert_comment_response_properties - Add case comment response properties for alertsalert_comment_response_properties_created_by - alert_comment_response_properties_pushed_by - alert_comment_response_properties_rule - alert_identifiers - Alert identifiersalert_indices - Alert indicescase_response_closed_by_properties - Case response properties for closed_bycase_response_connector_field_properties - Case response properties for connector fieldscase_response_created_by_properties - Case response properties for created_bycase_response_properties - Case response propertiescase_response_pushed_by_properties - Case response properties for pushed_bycase_response_updated_by_properties - Case response properties for updated_byconnector_types - external_service - owners - rule - Alerting rulesettings - severity_property - status - update_alert_comment_request_properties - Update case comment request properties for alertsupdate_case_comment_request - Update case comment requestupdate_user_comment_request_properties - Update case comment request properties for user commentsuser_comment_response_properties - Case response properties for user comments
+
+
+
+
+
+
alertId (optional)
+
created_at (optional)
+
created_by (optional)
+
id (optional)
+
index (optional)
+
owner (optional)
+
pushed_at (optional)
+
pushed_by (optional)
+
rule (optional)
+
type
+
+
user
+
updated_at (optional)
+
updated_by (optional)
+
version (optional)
+
comment (optional)
+
+
+
+
+
+
+
fields (optional)
+
id (optional)
String The identifier for the connector. To create a case without a connector, use
none.
+
name (optional)
String The name of the connector. To create a case without a connector, use
none.
+
type (optional)
+
+
+
+
+
Defines properties for case comment requests when type is alert.
+
+
alertId
+
index
+
owner
+
rule
+
type
+
+
alert
+
+
+
+
+
The add comment to case API request body varies depending on whether you are adding an alert or a comment.
+
+
alertId
+
index
+
owner
+
rule
+
type
+
+
user
+
comment
String The new comment. It is required only when
type is
user.
+
+
+
+
+
Defines properties for case comment requests when type is user.
+
+
comment
String The new comment. It is required only when
type is
user.
+
owner
+
type
+
+
user
+
+
+
+
+
+
+
alertId (optional)
+
created_at (optional)
+
created_by (optional)
+
id (optional)
+
index (optional)
+
owner (optional)
+
pushed_at (optional)
+
pushed_by (optional)
+
rule (optional)
+
type
+
+
alert
+
updated_at (optional)
+
updated_by (optional)
+
version (optional)
+
+
+
+
+
+
+
email (optional)
+
full_name (optional)
+
username (optional)
+
profile_uid (optional)
+
+
+
+
+
+
+
email (optional)
+
full_name (optional)
+
username (optional)
+
profile_uid (optional)
+
+
+
+
+
+
+
id (optional)
+
name (optional)
+
+
+
+
+
The alert identifier. It is required only when type is alert. If it is an array, index must also be an array with the same length or number of elements. This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
+
+
+
+
+
+
The alert index. It is required only when type is alert. If it is an array, alertId must also be an array with the same length or number of elements. This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
+
+
+
+
+
+
+
+
email
+
full_name
+
username
+
profile_uid (optional)
+
+
+
+
+
An object containing the connector fields. To create a case without a connector, specify null. If you want to omit any individual field, specify null as its value.
+
+
caseId (optional)
String The case identifier for Swimlane connectors.
+
category (optional)
String The category of the incident for ServiceNow ITSM and ServiceNow SecOps connectors.
+
destIp (optional)
String A comma-separated list of destination IPs for ServiceNow SecOps connectors.
+
impact (optional)
String The effect an incident had on business for ServiceNow ITSM connectors.
+
issueType (optional)
String The type of issue for Jira connectors.
+
issueTypes (optional)
+
malwareHash (optional)
String A comma-separated list of malware hashes for ServiceNow SecOps connectors.
+
malwareUrl (optional)
String A comma-separated list of malware URLs for ServiceNow SecOps connectors.
+
parent (optional)
String The key of the parent issue, when the issue type is sub-task for Jira connectors.
+
priority (optional)
String The priority of the issue for Jira and ServiceNow SecOps connectors.
+
severity (optional)
String The severity of the incident for ServiceNow ITSM connectors.
+
severityCode (optional)
BigDecimal The severity code of the incident for IBM Resilient connectors.
+
sourceIp (optional)
String A comma-separated list of source IPs for ServiceNow SecOps connectors.
+
subcategory (optional)
String The subcategory of the incident for ServiceNow ITSM connectors.
+
urgency (optional)
String The extent to which the incident resolution can be delayed for ServiceNow ITSM connectors.
+
+
+
+
+
+
+
email
+
full_name
+
username
+
profile_uid (optional)
+
+
+
+
+
+
+
closed_at
+
closed_by
+
comments
+
connector
+
created_at
+
created_by
+
description
+
duration
Integer 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.
+
external_service
+
id
+
owner
+
settings
+
severity
+
status
+
tags
+
title
+
totalAlerts
+
totalComment
+
updated_at
+
updated_by
+
version
+
+
+
+
+
+
+
email
+
full_name
+
username
+
profile_uid (optional)
+
+
+
+
+
+
+
email
+
full_name
+
username
+
profile_uid (optional)
+
+
+
+
+
The type of connector.
+
+
+
+
+
+
+
+
connector_id (optional)
+
connector_name (optional)
+
external_id (optional)
+
external_title (optional)
+
external_url (optional)
+
pushed_at (optional)
+
pushed_by (optional)
+
+
+
+
+
The application that owns the cases: Stack Management, Observability, or Elastic Security.
+
+
+
+
+
+
The rule that is associated with the alert. It is required only when type is alert. This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
+
+
id (optional)
+
name (optional)
+
+
+
+
+
An object that contains the case settings.
+
+
syncAlerts (optional)
Boolean Turns alert syncing on or off.
+
+
+
+
+
The severity of the case.
+
+
+
+
+
+
The status of the case.
+
+
+
+
+
+
Defines properties for case comment requests when type is alert.
+
+
alertId
+
id
String The identifier for the comment. To retrieve comment IDs, use the get comments API.
+
index
+
owner
+
rule
+
type
+
+
alert
+
version
String The current comment version. To retrieve version values, use the get comments API.
+
+
+
+
+
The update case comment API request body varies depending on whether you are updating an alert or a comment.
+
+
alertId
+
id
String The identifier for the comment. To retrieve comment IDs, use the get comments API.
+
index
+
owner
+
rule
+
type
+
+
user
+
version
String The current comment version. To retrieve version values, use the get comments API.
+
comment
String The new comment. It is required only when
type is
user.
+
+
+
+
+
Defines properties for case comment requests when type is user.
+
+
comment
String The new comment. It is required only when
type is
user.
+
id
String The identifier for the comment. To retrieve comment IDs, use the get comments API.
+
owner
+
type
+
+
user
+
version
String The current comment version. To retrieve version values, use the get comments API.
+
+
+
+
+
+
+
comment (optional)
+
created_at (optional)
+
created_by (optional)
+
id (optional)
+
owner (optional)
+
pushed_at (optional)
+
pushed_by (optional)
+
type
+
+
user
+
updated_at (optional)
+
updated_by (optional)
+
version (optional)
+
+
+