Update a case comment or alert
https://{kibana_url}
- PATCH /api/cases/{caseId}/comments
- PATCH /s/{space_id}/api/cases/{caseId}/comments
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. NOTE: You cannot change the comment type or the owner of a comment.
Path Parameters
-
caseIdstringrequired -
The identifier for the case. To retrieve case IDs, use the find cases API. All non-ASCII characters must be URL encoded.
Request
type: alert
Defines properties for case comment requests when type is alert.
-
alertId -
The alert identifiers. It is required only when
typeisalert. You can use an array of strings to add multiple alerts to a case, provided that they all relate to the same rule;indexmust also be an array with the same length or number of elements. Adding multiple alerts in this manner is recommended rather than calling the API multiple times. This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. -
idstringrequired -
The identifier for the comment. To retrieve comment IDs, use the get comments API.
-
index -
The alert indices. It is required only when
typeisalert. If you are adding multiple alerts to a case, use an array of strings; the position of each index name in the array must match the position of the corresponding alert identifier in thealertIdarray. This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. -
owner -
The application that owns the cases: Stack Management, Observability, or Elastic Security.
-
Values:
casesobservabilitysecuritySolution -
rule -
The rule that is associated with the alerts. It is required only when
typeisalert. This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. -
versionstringrequired -
The current comment version. To retrieve version values, use the get comments API.
type: user
Defines properties for case comment requests when type is user.
-
commentstring · max: 30000required -
The new comment. It is required only when
typeisuser. -
idstringrequired -
The identifier for the comment. To retrieve comment IDs, use the get comments API.
-
owner -
The application that owns the cases: Stack Management, Observability, or Elastic Security.
-
Values:
casesobservabilitysecuritySolution -
versionstringrequired -
The current comment version. To retrieve version values, use the get comments API.
Responses
Indicates a successful call.
-
assigneesnull · max: 10nullable -
An array containing users that are assigned to the case.
-
uidstringrequired -
A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API.
-
categorystringnullable -
The case category.
-
closed_atstringrequired nullable -
closed_by -
emailstringrequired nullable -
full_namestringrequired nullable -
profile_uidstring -
usernamestringrequired nullable -
commentsoneOf · max: 10000required -
An array of comment objects for the case.
-
alertIdstring -
created_atstring -
created_byobject -
emailstringrequired nullable -
full_namestringrequired nullable -
profile_uidstring -
usernamestringrequired nullable -
idstring -
indexstring -
owner -
The application that owns the cases: Stack Management, Observability, or Elastic Security.
-
Values:
casesobservabilitysecuritySolution -
pushed_atstringnullable -
pushed_byobjectnullable -
emailstringrequired nullable -
full_namestringrequired nullable -
profile_uidstring -
usernamestringrequired nullable -
type -
Values:
alert -
updated_atstringnullable -
updated_byobjectnullable -
emailstringrequired nullable -
full_namestringrequired nullable -
profile_uidstring -
usernamestringrequired nullable -
versionstring -
commentstring -
created_atstring -
created_by -
emailstringrequired nullable -
full_namestringrequired nullable -
profile_uidstring -
usernamestringrequired nullable -
idstring -
owner -
The application that owns the cases: Stack Management, Observability, or Elastic Security.
-
Values:
casesobservabilitysecuritySolution -
pushed_atstringnullable -
pushed_by -
emailstringrequired nullable -
full_namestringrequired nullable -
profile_uidstring -
usernamestringrequired nullable -
type -
Values:
user -
updated_atstringnullable -
updated_by -
emailstringrequired nullable -
full_namestringrequired nullable -
profile_uidstring -
usernamestringrequired nullable -
versionstring -
connectoroneOfrequired -
fieldsstringrequired 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.
-
idstringrequired -
The identifier for the connector. To create a case without a connector, use
none. To update a case to remove the connector, specifynone. -
namestringrequired -
The name of the connector. To create a case without a connector, use
none. To update a case to remove the connector, specifynone. -
type -
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 -
fieldsobjectrequired nullable -
An object containing the connector fields. If you want to omit any individual field, specify null as its value.
-
issueTypesstringrequired -
The type of incident.
-
severityCodestringrequired -
The severity code of the incident.
-
idstringrequired -
The identifier for the connector.
-
namestringrequired -
The name of the connector.
-
fieldsobjectrequired -
An object containing the connector fields. If you want to omit any individual field, specify null as its value.
-
categorystringrequired nullable -
The category of the incident.
-
impactstringrequired nullable -
The effect an incident had on business.
-
severitystringrequired nullable -
The severity of the incident.
-
subcategorystringrequired nullable -
The subcategory of the incident.
-
urgencystringrequired nullable -
The extent to which the incident resolution can be delayed.
-
idstringrequired -
The identifier for the connector. To retrieve connector IDs, use the find connectors API.
-
namestringrequired -
The name of the connector.
-
fieldsobjectrequired -
An object containing the connector fields. If you want to omit any individual field, specify null as its value.
-
categorystringrequired nullable -
The category of the incident.
-
destIpbooleanrequired nullable -
Indicates whether cases will send a comma-separated list of destination IPs.
-
malwareHashbooleanrequired nullable -
Indicates whether cases will send a comma-separated list of malware hashes.
-
malwareUrlbooleanrequired nullable -
Indicates whether cases will send a comma-separated list of malware URLs.
-
prioritystringrequired nullable -
The priority of the issue.
-
sourceIpbooleanrequired nullable -
Indicates whether cases will send a comma-separated list of source IPs.
-
subcategorystringrequired nullable -
The subcategory of the incident.
-
idstringrequired -
The identifier for the connector. To retrieve connector IDs, use the find connectors API.
-
namestringrequired -
The name of the connector.
-
fieldsobjectrequired -
An object containing the connector fields. If you want to omit any individual field, specify null as its value.
-
caseIdstringrequired nullable -
The case identifier for Swimlane connectors.
-
idstringrequired -
The identifier for the connector. To retrieve connector IDs, use the find connectors API.
-
namestringrequired -
The name of the connector.
-
created_atstringrequired -
created_by -
emailstringrequired nullable -
full_namestringrequired nullable -
profile_uidstring -
usernamestringrequired nullable -
customFieldsobject -
Custom field values for the case.
-
keystring -
The unique identifier for the custom field. The key value must exist in the case configuration settings.
-
type -
The custom field type. It must match the type specified in the case configuration settings.
-
Values:
texttoggle -
valuestring | booleannullable -
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. -
descriptionstringrequired -
durationintegerrequired 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.
-
external_service -
connector_idstring -
connector_namestring -
external_idstring -
external_titlestring -
external_urlstring -
pushed_atstring -
pushed_byobjectnullable -
emailstringnullable -
full_namestringnullable -
profile_uidstring -
usernamestringnullable -
idstringrequired -
owner -
The application that owns the cases: Stack Management, Observability, or Elastic Security.
-
Values:
casesobservabilitysecuritySolution -
settings -
An object that contains the case settings.
-
syncAlertsbooleanrequired -
Turns alert syncing on or off.
-
titlestringrequired -
totalAlertsintegerrequired -
totalCommentintegerrequired -
updated_atstringrequired nullable -
updated_by -
emailstringrequired nullable -
full_namestringrequired nullable -
profile_uidstring -
usernamestringrequired nullable -
versionstringrequired
type: .none
Defines properties for connectors when type is .none.
type: .cases-webhook
Defines properties for connectors when type is .cases-webhook.
type: .jira
Defines properties for connectors when type is .jira.
type: .resilient
Defines properties for connectors when type is .resilient.
type: .servicenow
Defines properties for connectors when type is .servicenow.
type: .servicenow-sir
Defines properties for connectors when type is .servicenow-sir.
type: .swimlane
Defines properties for connectors when type is .swimlane.
Authorization information is missing or invalid.
-
errorstring -
messagestring -
statusCodeinteger