Import an exception list

Base URL: https://{kibana_url}

POST /api/exception_lists/_import

Import an exception list and its associated items from an NDJSON file.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Query parameters

Request body

Responses

Successful response

application/json

Invalid input data response

application/json

Unsuccessful authentication response

application/json

Not enough privileges response

application/json

Internal server error response

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/exception_lists/_import
{
  "file": "exception_lists.ndjson"
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/exception_lists/_import" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: multipart/form-data" \
  -d '{
    "file": "exception_lists.ndjson"
  }'

Generated from the API spec

Response

{
  "errors": [
    {
      "error": {
        "message": "Error found importing exception list: Invalid value \\\u00224\\\u0022 supplied to \\\u0022list_id\\\u0022",
        "status_code": 400
      },
      "list_id": "(unknown list_id)"
    },
    {
      "error": {
        "message": "Found that item_id: \\\u0022f7fd00bb-dba8-4c93-9d59-6cbd427b6330\\\u0022 already exists. Import of item_id: \\\u0022f7fd00bb-dba8-4c93-9d59-6cbd427b6330\\\u0022 skipped.",
        "status_code": 409
      },
      "item_id": "f7fd00bb-dba8-4c93-9d59-6cbd427b6330",
      "list_id": "7d7cccb8-db72-4667-b1f3-648efad7c1ee"
    }
  ],
  "success": "false,",
  "success_count": "0,",
  "success_count_exception_list_items": 0,
  "success_count_exception_lists": "0,",
  "success_exception_list_items": "false,",
  "success_exception_lists": "false,"
}

{
  "error": "Bad Request",
  "message": "Multipart part \u0060file\u0060 is required and must contain a valid .ndjson exception list export",
  "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/_import] is unauthorized for user, this action is granted by the Kibana privileges [lists-all]",
  "statusCode": 403
}

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