This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
Summary exception container
editSummary exception container
editRetrieves an exception container summary.
Request URL
editPOST <kibana host>:<port>/api/exception_lists/summary
Request body
editA JSON object with these fields:
Name | Type | Description | Required |
---|---|---|---|
|
String |
Search filter clause. |
Yes |
|
String |
Exception container ID. |
Yes |
|
String |
Unique identifier. |
Yes |
|
String |
Determines whether the exception container is available in all Kibana spaces or just the space in which it is created, where:
|
Yes |
Example requests
editGets the summary from an exception container:
GET api/exception_lists/summary { "filter": "filter-clause", "id": "allowed-process-id", "list_id": "allowed-processes", "namespace_type": "single", }
Response code
edit-
200
- Indicates a successful call.
Response payload
editA summary of the exception container:
{ windows: 1, linux: 3, macos: 2, total: 6, }
For a host isolation exception, the values for windows
, linux
, macos
, and total
are all the same, as each host isolation exception entry applies to all operating systems.
For example:
{ windows: 5, linux: 5, macos: 5, total: 5, }