--- title: "Create an Elastic Endpoint rule exception list item" method: POST path: "/api/endpoint_list/items" tags: ["Security Endpoint Exceptions API"] --- # Create an Elastic Endpoint rule exception list item `POST /api/endpoint_list/items` **Spaces method and path for this operation:**
post /s/{space_id}/api/endpoint_list/items
Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information. Create an Elastic Endpoint exception list item, and associate it with the Elastic Endpoint exception list. ## Request body - object - `comments` SecurityEndpointExceptionsAPIExceptionListItemComment[] — Array of comment fields: - comment (string): Comments about the exception item. - `comment` string, nonempty, required — A string that does not contain only whitespace characters - `created_at` string, date-time, required — Autogenerated date of object creation. - `created_by` string, nonempty, required — A string that does not contain only whitespace characters - `id` string, nonempty, required — A string that does not contain only whitespace characters - `updated_at` string, date-time — Autogenerated date of last object update. - `updated_by` string, nonempty — A string that does not contain only whitespace characters - `description` string, required — Describes the exception list. - `entries` SecurityEndpointExceptionsAPIExceptionListItemEntry[], required - union - SecurityEndpointExceptionsAPIExceptionListItemEntryMatch - `field` string, nonempty, required — A string that does not contain only whitespace characters - `operator` 'excluded' | 'included', required - `type` 'match', required - `value` string, nonempty, required — A string that does not contain only whitespace characters - SecurityEndpointExceptionsAPIExceptionListItemEntryMatchAny - `field` string, nonempty, required — A string that does not contain only whitespace characters - `operator` 'excluded' | 'included', required - `type` 'match_any', required - `value` SecurityEndpointExceptionsAPINonEmptyString[], required - SecurityEndpointExceptionsAPIExceptionListItemEntryList - `field` string, nonempty, required — A string that does not contain only whitespace characters - `list` object, required - `id` string, nonempty, required — Value list's identifier. - `type` 'binary' | 'boolean' | 'byte' | 'date' | 'date_nanos' | 'date_range' | 'double' | 'double_range' | 'float' | 'float_range' | 'geo_point' | 'geo_shape' | 'half_float' | 'integer' | 'integer_range' | 'ip' | 'ip_range' | 'keyword' | 'long' | 'long_range' | 'shape' | 'short' | 'text', required — Specifies the Elasticsearch data type of excludes the list container holds. Some common examples: - `keyword`: Many ECS fields are Elasticsearch keywords - `ip`: IP addresses - `ip_range`: Range of IP addresses (supports IPv4, IPv6, and CIDR notation) - `operator` 'excluded' | 'included', required - `type` 'list', required - SecurityEndpointExceptionsAPIExceptionListItemEntryExists - `field` string, nonempty, required — A string that does not contain only whitespace characters - `operator` 'excluded' | 'included', required - `type` 'exists', required - SecurityEndpointExceptionsAPIExceptionListItemEntryNested - `entries` SecurityEndpointExceptionsAPIExceptionListItemEntryNestedEntryItem[], required - union - SecurityEndpointExceptionsAPIExceptionListItemEntryMatch - … - SecurityEndpointExceptionsAPIExceptionListItemEntryMatchAny - … - SecurityEndpointExceptionsAPIExceptionListItemEntryExists - … - `field` string, nonempty, required — A string that does not contain only whitespace characters - `type` 'nested', required - SecurityEndpointExceptionsAPIExceptionListItemEntryMatchWildcard - `field` string, nonempty, required — A string that does not contain only whitespace characters - `operator` 'excluded' | 'included', required - `type` 'wildcard', required - `value` string, nonempty, required — A string that does not contain only whitespace characters - `item_id` string, nonempty — Human readable string identifier, e.g. `trusted-linux-processes` - `meta` SecurityEndpointExceptionsAPIExceptionListItemMeta - `name` string, nonempty, required — Exception list name. - `os_types` SecurityEndpointExceptionsAPIExceptionListOsType[] - `tags` string[] - `type` 'simple', required ## Response `200` Successful response - SecurityEndpointExceptionsAPIExceptionListItem - `_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` SecurityEndpointExceptionsAPIExceptionListItemComment[], required — Array of comment fields: - comment (string): Comments about the exception item. - `comment` string, nonempty, required — A string that does not contain only whitespace characters - `created_at` string, date-time, required — Autogenerated date of object creation. - `created_by` string, nonempty, required — A string that does not contain only whitespace characters - `id` string, nonempty, required — A string that does not contain only whitespace characters - `updated_at` string, date-time — Autogenerated date of last object update. - `updated_by` string, nonempty — A string that does not contain only whitespace characters - `created_at` string, date-time, required — Autogenerated date of object creation. - `created_by` string, required — Autogenerated value - user that created object. - `description` string, required — Describes the exception list. - `entries` SecurityEndpointExceptionsAPIExceptionListItemEntry[], required - union - SecurityEndpointExceptionsAPIExceptionListItemEntryMatch - `field` string, nonempty, required — A string that does not contain only whitespace characters - `operator` 'excluded' | 'included', required - `type` 'match', required - `value` string, nonempty, required — A string that does not contain only whitespace characters - SecurityEndpointExceptionsAPIExceptionListItemEntryMatchAny - `field` string, nonempty, required — A string that does not contain only whitespace characters - `operator` 'excluded' | 'included', required - `type` 'match_any', required - `value` SecurityEndpointExceptionsAPINonEmptyString[], required - SecurityEndpointExceptionsAPIExceptionListItemEntryList - `field` string, nonempty, required — A string that does not contain only whitespace characters - `list` object, required - `id` string, nonempty, required — Value list's identifier. - `type` 'binary' | 'boolean' | 'byte' | 'date' | 'date_nanos' | 'date_range' | 'double' | 'double_range' | 'float' | 'float_range' | 'geo_point' | 'geo_shape' | 'half_float' | 'integer' | 'integer_range' | 'ip' | 'ip_range' | 'keyword' | 'long' | 'long_range' | 'shape' | 'short' | 'text', required — Specifies the Elasticsearch data type of excludes the list container holds. Some common examples: - `keyword`: Many ECS fields are Elasticsearch keywords - `ip`: IP addresses - `ip_range`: Range of IP addresses (supports IPv4, IPv6, and CIDR notation) - `operator` 'excluded' | 'included', required - `type` 'list', required - SecurityEndpointExceptionsAPIExceptionListItemEntryExists - `field` string, nonempty, required — A string that does not contain only whitespace characters - `operator` 'excluded' | 'included', required - `type` 'exists', required - SecurityEndpointExceptionsAPIExceptionListItemEntryNested - `entries` SecurityEndpointExceptionsAPIExceptionListItemEntryNestedEntryItem[], required - union - SecurityEndpointExceptionsAPIExceptionListItemEntryMatch - … - SecurityEndpointExceptionsAPIExceptionListItemEntryMatchAny - … - SecurityEndpointExceptionsAPIExceptionListItemEntryExists - … - `field` string, nonempty, required — A string that does not contain only whitespace characters - `type` 'nested', required - SecurityEndpointExceptionsAPIExceptionListItemEntryMatchWildcard - `field` string, nonempty, required — A string that does not contain only whitespace characters - `operator` 'excluded' | 'included', required - `type` 'wildcard', required - `value` string, nonempty, required — A string that does not contain only whitespace characters - `expire_time` string, date-time — The exception item’s expiration date, in ISO format. This field is only available for regular exception items, not endpoint exceptions. - `id` string, nonempty, required — Exception's identifier. - `item_id` string, nonempty, required — Human readable string identifier, e.g. `trusted-linux-processes` - `list_id` string, nonempty, 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` SecurityEndpointExceptionsAPIExceptionListItemMeta - `name` string, nonempty, required — Exception list name. - `namespace_type` 'agnostic' | 'single', 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. - `os_types` SecurityEndpointExceptionsAPIExceptionListOsType[] - `tags` string[] - `tie_breaker_id` string, required — Field used in search to ensure all containers are sorted and returned correctly. - `type` 'simple', required - `updated_at` string, date-time, required — Autogenerated date of last object update. - `updated_by` string, required — Autogenerated value - user that last updated object. ## Other responses - `400` — Invalid input data - `401` — Unsuccessful authentication - `403` — Insufficient privileges - `409` — Endpoint list item already exists - `500` — Internal server error --- [API](https://skmtc.net/elastic/apis/kibana-apis.md) · [All operations](https://skmtc.net/elastic/apis/kibana-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elastic/kibana-apis/versions/531c9e2a7d23/schema)