Update an exception list

Server: https://{kibana_url}

PUT /api/exception_lists
PUT /s/{space_id}/api/exception_lists

Refer to Spaces for more information.

Update an exception list using the id or list_id field.

Request

Exception list's properties

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

description string required

Describes the exception list.

id string · min: 1

Exception list's identifier.

list_id string · min: 1

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

Placeholder for metadata about the list container.

name string required

The name of the exception list.

namespace_type enum

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

Use this field to specify the operating system. Only enter one value.

Values: linux macos windows

tags [] object

String array containing words and phrases to help categorize exception containers.

type enum required

The type of exception list to be created. Different list types may denote where they can be utilized.

Values: detection rule_default endpoint endpoint_trusted_apps endpoint_trusted_devices endpoint_events endpoint_host_isolation_exceptions endpoint_blocklists endpoint_custom_yara_signatures

version integer · min: 1

The document version, automatically increasd on updates.

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.

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.

id string · min: 1 required

Exception list's identifier.

immutable boolean required

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

Placeholder for metadata about the list container.

name string required

The name of the exception list.

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

Use this field to specify the operating system. Only enter one value.

Values: linux macos windows

tags [] object

String array containing words and phrases to help categorize exception containers.

tie_breaker_id string required

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

type enum required

The type of exception list to be created. Different list types may denote where they can be utilized.

updated_at string required

Autogenerated date of last object update.

updated_by string required

Autogenerated value - user that last updated object.

version integer · min: 1 required

The document version, automatically increasd on updates.

Invalid input data response

application/json

Unsuccessful authentication response

application/json

Not enough privileges response

application/json

Exception list not found response

application/json

Internal server error response

application/json

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT /api/exception_lists
{
  "description": "Different description",
  "list_id": "simple_list",
  "name": "Updated exception list name",
  "os_types": [
    "linux"
  ],
  "tags": [
    "draft",
    "malware"
  ],
  "type": "detection"
}

curl Shell

curl -X PUT "https://{kibana_url}/api/exception_lists" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "Different description",
  "list_id": "simple_list",
  "name": "Updated exception list name",
  "os_types": [
    "linux"
  ],
  "tags": [
    "draft",
    "malware"
  ],
  "type": "detection"
}'

Response

{
  "_version": "WzExLDFd",
  "created_at": "2025-01-07T20:43:55.264Z",
  "created_by": "elastic",
  "description": "Different description",
  "id": "fa7f545f-191b-4d32-b1f0-c7cd62a79e55",
  "immutable": false,
  "list_id": "simple_list",
  "name": "Updated exception list name",
  "namespace_type": "single",
  "os_types": [],
  "tags": [
    "draft malware"
  ],
  "tie_breaker_id": "319fe983-acdd-4806-b6c4-3098eae9392f",
  "type": "detection",
  "updated_at": "2025-01-07T21:32:03.726Z",
  "updated_by": "elastic",
  "version": 2
}

{
  "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 [PUT /api/exception_lists] is unauthorized for user, this action is granted by the Kibana privileges [lists-all]",
  "statusCode": 403
}

{
  "message\u0022": "exception list id: \u0022foo\u0022 does not exist",
  "status_code\u0022": 404
}

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

Request { _version , description , id , list_id , meta , name , namespace_type , os_types , tags , type , version , }

Responses

Request