Get an exception list summary

Base URL: https://{kibana_url}

GET /api/exception_lists/summary

Auth

Get a summary of the specified exception list.

Query parameters

id string · format: nonempty · min length: 1: Exception list's identifier generated upon creation.; Example: 9e5fc75a-a3da-46c5-96e3-a2ec59c6bb85
list_id string · format: nonempty · min length: 1: Exception list's human readable identifier.; Example: simple_list
namespace_type enum: single returns summary for a list in the current space; agnostic for a space-agnostic list. Must line up with id / list_id used to look up the list.; Values: agnostic single
filter string: Search filter clause

Responses

Successful response

application/json

linux integer · min: 0
macos integer · min: 0
total integer · min: 0
windows integer · min: 0

Invalid input data response

application/json

Unsuccessful authentication response

application/json

Not enough privileges response

application/json

Exception list not found response

application/json

Internal server error response

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/exception_lists/summary

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/exception_lists/summary" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

{
  "linux": 0,
  "macos": 0,
  "total": 0,
  "windows": 0
}

{
  "error": "Bad Request",
  "message": "[request query]: namespace_type.0: Invalid enum value. Expected \u0027agnostic\u0027 | \u0027single\u0027, received \u0027blob\u0027",
  "statusCode": 400
}

{
  "error": "Unauthorized",
  "message": "[security_exception\\n\\tRoot causes:\\n\\t\\tsecurity_exception: unable to authenticate user [elastic] for REST request [/_security/_authenticate]]: unable to authenticate user [elastic] for REST request [/_security/_authenticate]",
  "statusCode": 401
}

{
  "error": "Forbidden",
  "message": "API [GET /api/exception_lists/summary?list_id=simple_list\u0026namespace_type=agnostic] is unauthorized for user, this action is granted by the Kibana privileges [lists-summary]",
  "statusCode": 403
}

{
  "message\u0022": "exception list id: \u0022foo\u0022 does not exist",
  "status_code\u0022": 404
}

{
  "message": "Internal Server Error",
  "status_code": 500
}