Create an exception list
https://{kibana_url}
- POST /api/exception_lists
- POST /s/{space_id}/api/exception_lists
Refer to Spaces for more information.
An exception list groups exception items and can be associated with detection rules. You can assign detection rules with multiple exception lists.
info All exception items added to the same list are evaluated using
ORlogic. That is, if any of the items in a list evaluate totrue, the exception prevents the rule from generating an alert. Likewise,ORlogic is used for evaluating exceptions when more than one exception list is assigned to a rule. To use theANDoperator, you can define multiple clauses (entries) in a single exception item.
Request
Exception list's properties
-
descriptionstringrequired -
list_idstring · min: 1 -
A string that does not contain only whitespace characters
-
metaobject -
namestringrequired -
namespace_type -
Determines whether the exception container is available in all Kibana spaces or just the space in which it is created, where:
single: Only available in the Kibana space in which it is created.agnostic: Available in all Kibana spaces.
-
Values:
agnosticsingle -
os_typesobject -
Values:
linuxmacoswindows -
typerequired -
Values:
detectionrule_defaultendpointendpoint_trusted_appsendpoint_eventsendpoint_host_isolation_exceptionsendpoint_blocklists -
versioninteger · min: 1
Responses
Successful response
-
_versionstring -
created_atstringrequired -
created_bystringrequired -
descriptionstringrequired -
idstring · min: 1required -
A string that does not contain only whitespace characters
-
immutablebooleanrequired -
list_idstring · min: 1required -
A string that does not contain only whitespace characters
-
metaobject -
namestringrequired -
namespace_typerequired -
Determines whether the exception container is available in all Kibana spaces or just the space in which it is created, where:
single: Only available in the Kibana space in which it is created.agnostic: Available in all Kibana spaces.
-
Values:
agnosticsingle -
os_typesobject -
Values:
linuxmacoswindows -
tie_breaker_idstringrequired -
typerequired -
Values:
detectionrule_defaultendpointendpoint_trusted_appsendpoint_eventsendpoint_host_isolation_exceptionsendpoint_blocklists -
updated_atstringrequired -
updated_bystringrequired -
versioninteger · min: 1required
Invalid input data response
-
errorstringrequired -
messagestringrequired -
statusCodeintegerrequired
-
messagestringrequired -
status_codeintegerrequired
Unsuccessful authentication response
-
errorstringrequired -
messagestringrequired -
statusCodeintegerrequired
Not enough privileges response
-
errorstringrequired -
messagestringrequired -
statusCodeintegerrequired
Exception list already exists response
-
messagestringrequired -
status_codeintegerrequired
Internal server error response
-
messagestringrequired -
status_codeintegerrequired