Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Security solution] [Endpoint] Adds documentation for exceptions container summary #824

2 changes: 2 additions & 0 deletions docs/detections/api/exceptions-api-index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ include::exceptions/api-get-exception-items.asciidoc[]

include::exceptions/api-update-exception-container.asciidoc[]

include::exceptions/api-summary-exception-container.asciidoc[]

include::exceptions/api-update-exception-item.asciidoc[]

include::exceptions/api-delete-exception-container.asciidoc[]
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
[[exceptions-api-summary-exception-container]]
=== Summary exception container

Retrieves an exception container summary.

NOTE: Console supports only Elasticsearch APIs. You cannot interact with {kib} APIs with Console and must use `curl` or another HTTP tool instead. For more information, refer to https://www.elastic.co/guide/en/kibana/current/console-kibana.html[Console].

==== Request URL

`POST <kibana host>:<port>/api/exception_lists/summary`

==== Request body

A JSON object with these fields:

[width="100%",options="header"]
|==============================================
|Name |Type |Description |Required

|`id` |String |Exception container ID. |Yes
|`list_id` |String |Unique identifier. |Yes
|`namespace_type` |String a|Determines whether the exception container is available in all {kib} spaces or just the space in which it is created, where:

* `single`: Only available in the {kib} space in which it is created.
* `agnostic`: Available in all {kib} spaces.

|Yes

|==============================================

===== Example requests

Gets the summary from an exception container:

[source,console]
--------------------------------------------------
GET api/exception_lists/summary
{
"id": "allowes-process-id",
"list_id": "allowed-processes",
"namespace_type": "single",
}
--------------------------------------------------
// KIBANA

==== Response code

`200`::
Indicates a successful call.


==== Response payload

A summary of the exception container:

[source,json]
--------------------------------------------------
{
windows: 1,
linux: 3,
macos: 2,
total: 6,
}
--------------------------------------------------