Export an exception list Beta

POST /api/exception_lists/_export

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

Query parameters

  • id string Required

    Exception list's identifier

    Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.

  • list_id string Required

    Exception list's human identifier

    Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.

  • namespace_type string Required

    Determines whether the exception container is available in all Kibana spaces or just the space in which it is created, where:

    • single: Only available in the Kibana space in which it is created.
    • agnostic: Available in all Kibana spaces.

    Values are agnostic or single. Default value is single.

  • include_expired_exceptions string Required

    Determines whether to include expired exceptions in the exported list

    Values are true or false. Default value is true.

Responses

POST /api/exception_lists/_export 
curl \
 -X POST https://localhost:5601/api/exception_lists/_export?id=string&list_id=string&namespace_type=single&include_expired_exceptions=true
Response examples (200) 
@file
Response examples (400) 
{
  "error": "string",
  "message": "string",
  "statusCode": 42
}
{
  "message": "string",
  "status_code": 42
}
Response examples (401) 
{
  "error": "string",
  "message": "string",
  "statusCode": 42
}
Response examples (403) 
{
  "error": "string",
  "message": "string",
  "statusCode": 42
}
Response examples (404) 
{
  "message": "string",
  "status_code": 42
}
Response examples (500) 
{
  "message": "string",
  "status_code": 42
}