Bulk update Attack discoveries
https://{kibana_url}
- POST /api/attack_discovery/_bulk
- POST /s/{space_id}/api/attack_discovery/_bulk
Refer to Spaces for more information.
Performs bulk updates on multiple Attack discoveries, including workflow status changes and visibility settings. This endpoint allows efficient batch processing of alert modifications without requiring individual API calls for each alert.
Request
Bulk update parameters for Attack discoveries
-
updateobjectrequired -
Configuration object containing all parameters for the bulk update operation
-
enable_field_renderingboolean · default: false -
Enables a markdown syntax used to render pivot fields, for example
{{ user.name james }}. When disabled, the same example would be rendered asjames. This is primarily used for Attack Discovery views within Kibana. Defaults tofalse. -
idsstringrequired -
Array of Attack Discovery IDs to update
-
kibana_alert_workflow_status -
When provided, update the kibana.alert.workflow_status of the attack discovery alerts
-
Values:
openacknowledgedclosed -
visibility -
When provided, update the visibility of the alert, as determined by the kibana.alert.attack_discovery.users field
-
Values:
not_sharedshared -
with_replacementsboolean · default: true -
When true, returns the updated Attack discoveries with text replacements applied to the detailsMarkdown, entitySummaryMarkdown, summaryMarkdown, and title fields. This substitutes anonymized values with human-readable equivalents. Defaults to
true.
Responses
Indicates a successful call.
-
dataobjectrequired -
Array of updated Attack Discovery alert objects. Each item includes the applied modifications from the bulk update request.
-
alert_idsstringrequired -
The alert IDs that the attack discovery is based on
-
alert_rule_uuidstring -
The optional kibana.alert.rule.uuid of the rule that generated this attack discovery (not applicable to ad hock runs)
-
alert_startstring -
The optional time the attack discovery alert was created
-
alert_updated_atstring -
The optional time the attack discovery alert was last updated
-
alert_updated_by_user_idstring -
The optional id of the user who last updated the attack discovery alert
-
alert_updated_by_user_namestring -
The optional username of the user who updated the attack discovery alert
-
alert_workflow_statusstring -
The optional kibana.alert.workflow_status of this attack discovery
-
alert_workflow_status_updated_atstring -
The optional time the attack discovery alert workflow status was last updated
-
assigneesstring -
The optional array of user-IDs who have been assigned the attack
-
connector_idstringrequired -
The ID of the connector that generated the attack discovery
-
connector_namestringrequired -
The (human readable) name of the connector that generated the attack discovery
-
details_markdownstringrequired -
Details of the attack with bulleted markdown that always uses special syntax for field names and values from the source data.
-
entity_summary_markdownstring -
An optional, short (no more than a sentence) summary of the attack discovery featuring only the host.name and user.name fields (when they are applicable), using the same syntax
-
generation_uuidstringrequired -
The generation ID of the run that created the attack discovery
-
idstringrequired -
The unique ID of the attack discovery
-
indexstring -
The concrete Elasticsearch index where this attack discovery is stored
-
mitre_attack_tacticsstring -
An optional array of MITRE ATT&CK tactic for the attack discovery
-
replacementsobject -
Replacements object used to anonymize/deanonymize messages
-
risk_scoreinteger -
The optional, (but typically populated after generation) risk score of the alert
-
summary_markdownstringrequired -
A markdown summary of attack discovery, using the same syntax
-
The optional array of tags assigned the attack
-
timestampstring · min: 1required -
A string that represents a timestamp in ISO 8601 format and does not contain only whitespace characters.
-
titlestringrequired -
A title for the attack discovery, in plain text
-
user_idstring -
The optional id of the user who generated the attack discovery
-
user_namestring -
The optional username of the user who generated the attack discovery, (not applicable to attack discoveries generated by rules)
Bad Request response.
-
errorstringrequired -
Error type
-
messagestringrequired -
Human-readable error message describing what went wrong with the bulk update request
-
status_codenumberrequired -
HTTP status code