Summary exception containeredit
Retrieves an exception container summary.
Console supports only Elasticsearch APIs. You cannot interact with Kibana APIs with Console and must use curl
or another HTTP tool instead. For more information, refer to Run Elasticsearch API requests.
Request URLedit
POST <kibana host>:<port>/api/exception_lists/summary
Request bodyedit
A 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 requestsedit
Gets 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 codeedit
-
200
- Indicates a successful call.
Response payloadedit
A 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, }