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.

Sign up for GitHub

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

[8.10] [API docs] Expands on docs for finding exception containers (backport #3456) #3906

Merged
merged 1 commit into from
Sep 11, 2023
Merged

[8.10] [API docs] Expands on docs for finding exception containers (backport #3456) #3906

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions docs/detections/api/exceptions/api-find-exception-containers.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,22 @@ See {ref}/search-request-body.html#request-body-search-search-after[Search After
associated with a {kib} space or available in all spaces (`agnostic` or
`single`).

|`filter` |String a|Filters the returned results according to the value of the
specified field, using the `<field name>:<field value>` syntax, where
`<field name>` can be:
|`filter` |String a|Filters the returned results according to the value of the specified field.

Uses the `so type.field name:field value` syntax, where `so type` can be:

* `exception-list`: Specify a space-aware exception list.
* `exception-list-agnostic`: Specify an exception list that is shared across spaces.

And `field name` can be:

* `name`
* `type`
* `created_by`
* `updated_by`

|`search` |String a|Filters the returned results according to the {ref}/query-dsl-simple-query-string-query.html#simple-query-string-syntax[simple query] filter.

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

===== Example request
Expand Down