Export an exception list

View as Markdown
POST /api/exception_lists/_export
Api key auth Basic auth

Spaces method and path for this operation:

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

Refer to Spaces for more information.

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

Query parameters

  • id string(nonempty) Required

    Exception list's identifier

    Minimum length is 1.

  • list_id string(nonempty) Required

    Exception list's human identifier

    Minimum length is 1.

  • 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.

  • 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

  • 200 application/ndjson

    Successful response

    A .ndjson file containing specified exception list and its items
  • 400 application/json

    Invalid input data response

    One of:
    Security_Exceptions_API_PlatformErrorResponse object Security_Exceptions_API_SiemErrorResponse object
  • 401 application/json

    Unsuccessful authentication response

    Hide response attributes Show response attributes object
    • error string Required
    • message string Required
    • statusCode integer Required
  • 403 application/json

    Not enough privileges response

    Hide response attributes Show response attributes object
    • error string Required
    • message string Required
    • statusCode integer Required
  • 404 application/json

    Exception list not found response

    Hide response attributes Show response attributes object
    • message string Required
    • status_code integer Required
  • 500 application/json

    Internal server error response

    Hide response attributes Show response attributes object
    • message string Required
    • status_code integer Required
POST /api/exception_lists/_export 
curl \
 --request POST 'https://localhost:5601/api/exception_lists/_export?id=string&list_id=string&namespace_type=agnostic&include_expired_exceptions=true' \
 --header "Authorization: $API_KEY"