Create rule exception items

Server: https://{kibana_url}

POST /api/detection_engine/rules/{id}/exceptions
POST /s/{space_id}/api/detection_engine/rules/{id}/exceptions

Api key auth Basic auth

Refer to Spaces for more information.

Create exception items that apply to a single detection rule.

Path Parameters

id string required: Detection rule's identifier

Request

Rule exception items.

items [] object required

Responses

Successful response

application/json

Response Type: [] object

_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

Internal server error response

application/json

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST /api/detection_engine/rules/{id}/exceptions
{
  "items": [
    {
      "description": "This is a sample detection type exception item.",
      "entries": [
        {
          "field": "actingProcess.file.signer",
          "operator": "excluded",
          "type": "exists"
        },
        {
          "field": "host.name",
          "operator": "included",
          "type": "match_any",
          "value": [
            "saturn",
            "jupiter"
          ]
        }
      ],
      "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/detection_engine/rules/{id}/exceptions" \
  -H "Content-Type: application/json" \
  -d '{
  "items": [
    {
      "description": "This is a sample detection type exception item.",
      "entries": [
        {
          "field": "actingProcess.file.signer",
          "operator": "excluded",
          "type": "exists"
        },
        {
          "field": "host.name",
          "operator": "included",
          "type": "match_any",
          "value": [
            "saturn",
            "jupiter"
          ]
        }
      ],
      "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": "WzQsMV0=",
    "comments": [],
    "created_at": "2025-01-07T20:07:33.119Z",
    "created_by": "elastic",
    "description": "This is a sample detection type exception item.",
    "entries": [
      {
        "field": "actingProcess.file.signer",
        "operator": "excluded",
        "type": "exists"
      },
      {
        "field": "host.name",
        "operator": "included",
        "type": "match_any",
        "value": [
          "saturn",
          "jupiter"
        ]
      }
    ],
    "id": "71a9f4b2-c85c-49b4-866f-c71eb9e67da2",
    "item_id": "simple_list_item",
    "list_id": "simple_list",
    "name": "Sample Exception List Item",
    "namespace_type": "single",
    "os_types": [
      "linux"
    ],
    "tags": [
      "malware"
    ],
    "tie_breaker_id": "09434836-9db9-4942-a234-5a9268e0b34c",
    "type": "simple",
    "updated_at": "2025-01-07T20:07:33.119Z",
    "updated_by": "elastic"
  }
]

{
  "error": "Bad Request",
  "message": "Invalid request payload JSON format",
  "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
}

{
  "message": "Unable to create exception-list",
  "status_code": 403
}

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