From 51da1b9a84fd7500ebb571aa786691332b7298d3 Mon Sep 17 00:00:00 2001 From: David Sanchez Soler Date: Thu, 22 Jul 2021 10:04:19 +0200 Subject: [PATCH 1/5] Adds documentation --- .../api-summary-exception-container.asciidoc | 65 +++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 docs/detections/api/exceptions/api-summary-exception-container.asciidoc diff --git a/docs/detections/api/exceptions/api-summary-exception-container.asciidoc b/docs/detections/api/exceptions/api-summary-exception-container.asciidoc new file mode 100644 index 0000000000..89a122fb6a --- /dev/null +++ b/docs/detections/api/exceptions/api-summary-exception-container.asciidoc @@ -0,0 +1,65 @@ +[[exceptions-api-summary-exception-container]] +=== Summary exception container + +Retrieves an exception container summary. + +NOTE: The {kib} Console supports only Elasticsearch APIs. You cannot interact with the {kib} APIs with the 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 :/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 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, +} +-------------------------------------------------- + From 54aec5cfadb558a89d18f658a35767d271f09324 Mon Sep 17 00:00:00 2001 From: Janeen Mikell-Straughn Date: Tue, 27 Jul 2021 17:03:40 -0400 Subject: [PATCH 2/5] Adding file to index. --- docs/detections/api/exceptions-api-index.asciidoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/detections/api/exceptions-api-index.asciidoc b/docs/detections/api/exceptions-api-index.asciidoc index aab62878a8..a80849aa6d 100644 --- a/docs/detections/api/exceptions-api-index.asciidoc +++ b/docs/detections/api/exceptions-api-index.asciidoc @@ -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[] From 1a6c77fd41a709945bc6ddf0b20e014a1f716985 Mon Sep 17 00:00:00 2001 From: Janeen Mikell-Straughn Date: Wed, 28 Jul 2021 11:10:29 -0400 Subject: [PATCH 3/5] Update api-summary-exception-container.asciidoc --- .../api/exceptions/api-summary-exception-container.asciidoc | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/detections/api/exceptions/api-summary-exception-container.asciidoc b/docs/detections/api/exceptions/api-summary-exception-container.asciidoc index 89a122fb6a..503948008a 100644 --- a/docs/detections/api/exceptions/api-summary-exception-container.asciidoc +++ b/docs/detections/api/exceptions/api-summary-exception-container.asciidoc @@ -30,7 +30,7 @@ A JSON object with these fields: ===== Example requests -Gets summary from an exception container: +Gets the summary from an exception container: [source,console] -------------------------------------------------- @@ -51,7 +51,7 @@ GET api/exception_lists/summary ==== Response payload -A summary of the exception container +A summary of the exception container: [source,json] -------------------------------------------------- @@ -62,4 +62,3 @@ A summary of the exception container total: 6, } -------------------------------------------------- - From aab1571717491dc5ff45b20157aeb9db8a27d6bc Mon Sep 17 00:00:00 2001 From: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com> Date: Wed, 28 Jul 2021 13:25:39 -0400 Subject: [PATCH 4/5] Update docs/detections/api/exceptions/api-summary-exception-container.asciidoc Co-authored-by: nastasha-solomon <79124755+nastasha-solomon@users.noreply.github.com> --- .../api/exceptions/api-summary-exception-container.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/detections/api/exceptions/api-summary-exception-container.asciidoc b/docs/detections/api/exceptions/api-summary-exception-container.asciidoc index 503948008a..b2e2952798 100644 --- a/docs/detections/api/exceptions/api-summary-exception-container.asciidoc +++ b/docs/detections/api/exceptions/api-summary-exception-container.asciidoc @@ -3,7 +3,7 @@ Retrieves an exception container summary. -NOTE: The {kib} Console supports only Elasticsearch APIs. You cannot interact with the {kib} APIs with the 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]. +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 From fffe8409e0fde484d2af9a02a0018839d4416c15 Mon Sep 17 00:00:00 2001 From: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com> Date: Wed, 28 Jul 2021 13:25:59 -0400 Subject: [PATCH 5/5] Update docs/detections/api/exceptions/api-summary-exception-container.asciidoc Committing feedback. Co-authored-by: nastasha-solomon <79124755+nastasha-solomon@users.noreply.github.com> --- .../api/exceptions/api-summary-exception-container.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/detections/api/exceptions/api-summary-exception-container.asciidoc b/docs/detections/api/exceptions/api-summary-exception-container.asciidoc index b2e2952798..8c396f2765 100644 --- a/docs/detections/api/exceptions/api-summary-exception-container.asciidoc +++ b/docs/detections/api/exceptions/api-summary-exception-container.asciidoc @@ -17,7 +17,7 @@ A JSON object with these fields: |============================================== |Name |Type |Description |Required -|`id` |String |Exception container id. |Yes +|`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: