Export an exception list

Base URL: https://{kibana_url}

POST /api/exception_lists/_export
POST /s/{space_id}/api/exception_lists/_export

Auth

Export an exception list and its associated items to an NDJSON file.

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Query parameters

id string · format: nonempty · min length: 1 required: Exception list's internal id (UUID) returned on create; use with list_id and namespace_type for an unambiguous target.; Example: 9e5fc75a-a3da-46c5-96e3-a2ec59c6bb85
list_id string · format: nonempty · min length: 1 required: Human-readable list_id of the exception list to export, as shown in the UI and API responses.; Example: simple_list
namespace_type enum required: single exports a list in the current Kibana space; agnostic exports a global (space-agnostic) list.; Values: agnostic single
include_expired_exceptions enum · default: true required: Determines whether to include expired exceptions in the exported list. Expiration date defined by expire_time.; Values: true false

Responses

Successful response

application/ndjson

Response Type: string · format: binary

Invalid input data response

application/json

One of:

error string required
message string required
statusCode integer required

Unsuccessful authentication response

application/json

error string required
message string required
statusCode integer required

Not enough privileges response

application/json

error string required
message string required
statusCode integer required

Exception list not found response

application/json

message string required
status_code integer required

Internal server error response

application/json

message string required
status_code integer required

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/exception_lists/_export?id=9e5fc75a-a3da-46c5-96e3-a2ec59c6bb85&list_id=simple_list&namespace_type=agnostic&include_expired_exceptions=true

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/exception_lists/_export?id=9e5fc75a-a3da-46c5-96e3-a2ec59c6bb85&list_id=simple_list&namespace_type=agnostic&include_expired_exceptions=true" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

{"_version":"WzExNDU5LDFd","created_at":"2025-01-09T16:18:17.757Z","created_by":"elastic","description":"This is a sample detection type exception","id":"c86c2da0-2ab6-4343-b81c-216ef27e8d75","immutable":false,"list_id":"simple_list","name":"Sample Detection Exception List","namespace_type":"single","os_types":[],"tags":["user added string for a tag","malware"],"tie_breaker_id":"cf4a7b92-732d-47f0-a0d5-49a35a1736bf","type":"detection","updated_at":"2025-01-09T16:18:17.757Z","updated_by":"elastic","version":1}
{"_version":"WzExNDYxLDFd","comments":[],"created_at":"2025-01-09T16:18:42.308Z","created_by":"elastic","description":"This is a sample endpoint type exception","entries":[{"type":"exists","field":"actingProcess.file.signer","operator":"excluded"},{"type":"match_any","field":"host.name","value":["some host","another host"],"operator":"included"}],"id":"f37597ce-eaa7-4b64-9100-4301118f6806","item_id":"simple_list_item","list_id":"simple_list","name":"Sample Endpoint Exception List","namespace_type":"single","os_types":["linux"],"tags":["user added string for a tag","malware"],"tie_breaker_id":"4ca3ef3e-9721-42c0-8107-cf47e094d40f","type":"simple","updated_at":"2025-01-09T16:18:42.308Z","updated_by":"elastic"}
{"exported_exception_list_count":1,"exported_exception_list_item_count":1,"missing_exception_list_item_count":0,"missing_exception_list_items":[],"missing_exception_lists":[],"missing_exception_lists_count":0}

{
  "error": "Bad Request",
  "message": "[request query]: list_id: Required, namespace_type: Required",
  "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 [POST /api/exception_lists/_export] is unauthorized for user, this action is granted by the Kibana privileges [lists-all]",
  "statusCode": 403
}

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

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