Create an exception list item

Server: https://{kibana_url}

POST /api/exception_lists/items

Api key auth Basic auth

Create an exception item and associate it with the specified exception list.

info Before creating exception items, you must create an exception list.

Request

Responses

Successful response

application/json

_version string

The version id, normally returned by the API when the item was retrieved. Use it ensure updates are done against the latest version.

comments [] object required

Array of comment fields:

comment (string): Comments about the exception item.

created_at string required

Autogenerated date of object creation.

created_by string required

Autogenerated value - user that created object.

description string required

Describes the exception list.

entries [] object required

expire_time string

The exception item’s expiration date, in ISO format. This field is only available for regular exception items, not endpoint exceptions.

id string · min: 1 required

Exception's identifier.

item_id string · min: 1 required

Human readable string identifier, e.g. trusted-linux-processes

list_id string · min: 1 required

The exception list's human-readable string identifier.

For endpoint artifacts, use one of the following values:

endpoint_list: Elastic Endpoint exceptions list
endpoint_trusted_apps: Trusted applications list
endpoint_trusted_devices: Trusted devices list
endpoint_event_filters: Event filters list
endpoint_host_isolation_exceptions: Host isolation exceptions list
endpoint_blocklists: Blocklist

meta object

name string · min: 1 required

Exception list name.

namespace_type enum 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.

For endpoint artifacts, the namespace_type must always be agnostic. Space awareness for endpoint artifacts is enforced based on Elastic Defend policy assignments.

Values: agnostic single

os_types [] object

Values: linux macos windows

tags [] object

tie_breaker_id string required

Field used in search to ensure all containers are sorted and returned correctly.

type enum required

Values: simple

updated_at string required

Autogenerated date of last object update.

updated_by string required

Autogenerated value - user that last updated object.

Invalid input data response

application/json

Unsuccessful authentication response

application/json

Not enough privileges response

application/json

Exception list item already exists response

application/json

Internal server error response

application/json

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /api/exception_lists/items
{
  "description": "This is a sample detection type exception item.",
  "entries": [
    {
      "field": "actingProcess.file.signer",
      "operator": "excluded",
      "type": "exists"
    }
  ],
  "item_id": "simple_list_item",
  "list_id": "simple_list",
  "name": "Sample Exception List Item",
  "namespace_type": "single",
  "os_types": [
    "linux"
  ],
  "tags": [
    "malware"
  ],
  "type": "simple"
}

curl Shell

curl -X POST "https://{kibana_url}/api/exception_lists/items" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "This is a sample detection type exception item.",
  "entries": [
    {
      "field": "actingProcess.file.signer",
      "operator": "excluded",
      "type": "exists"
    }
  ],
  "item_id": "simple_list_item",
  "list_id": "simple_list",
  "name": "Sample Exception List Item",
  "namespace_type": "single",
  "os_types": [
    "linux"
  ],
  "tags": [
    "malware"
  ],
  "type": "simple"
}'

Response

{
  "_version": "WzYsMV0=",
  "comments": [],
  "created_at": "2025-01-09T01:16:23.322Z",
  "created_by": "elastic",
  "description": "This is a sample exception that has no item_id so it is autogenerated.",
  "entries": [
    {
      "field": "actingProcess.file.signer",
      "operator": "excluded",
      "type": "exists"
    }
  ],
  "id": "323faa75-c657-4fa0-9084-8827612c207b",
  "item_id": "80e6edf7-4b13-4414-858f-2fa74aa52b37",
  "list_id": "8c1aae4c-1ef5-4bce-a2e3-16584b501783",
  "name": "Sample Autogenerated Exception List Item ID",
  "namespace_type": "single",
  "os_types": [],
  "tags": [
    "malware"
  ],
  "tie_breaker_id": "d6799986-3a23-4213-bc6d-ed9463a32f23",
  "type": "simple",
  "updated_at": "2025-01-09T01:16:23.322Z",
  "updated_by": "elastic"
}

{
  "error": "Bad Request,",
  "message": "[request body]: list_id: Expected string, received number",
  "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/items] is unauthorized for user, this action is granted by the Kibana privileges [lists-all]",
  "statusCode": 403
}

{
  "message": "exception list item id: \\\u0022simple_list_item\\\u0022 already exists",
  "status_code": 409
}

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