Sign in
Security Exceptions API

Get exception lists

Spaces method and path for this operation:

<div><span class="operation-verb get">get</span>&nbsp;<span class="operation-path">/s/{space_id}/api/exception_lists/_find</span></div>

Refer to Spaces for more information.

Get a list of all exception list containers.

get/api/exception_lists/_find

Query parameters

filterstring
Example:exception-list.attributes.name:%Detection%20List

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.
namespace_typeSecurityExceptionsAPIExceptionNamespaceType[]

Determines whether the returned containers are Kibana associated with a Kibana space or available in all spaces (agnostic or single)

pageinteger
Example:1

The page number to return

per_pageinteger
Example:20

The number of exception lists to return per page

sort_fieldstring
Example:name

Determines which field is used to sort the results.

sort_order'desc' | 'asc'
Example:desc

Determines the sort order, which can be desc or asc.

Response

Successful response

pageinteger required
per_pageinteger required
totalinteger required

Example response

{
  "data": [
    {
      "description": "This list tracks allowlisted values.",
      "id": "9e5fc75a-a3da-46c5-96e3-a2ec59c6bb85",
      "list_id": "simple_list",
      "name": "My exception list"
    }
  ]
}

Changes

Changed in 1 of the 176 revisions of this API.1

  • 707a2918b22b1See the full diff
    • ●

      added the new endpoint_custom_yara_signatures enum value to the // response property for the response status

      response-property-enum-value-added

Of the 176 revisions, 20 have no diff computed.