Create an exception list item

Base URL
https://{kibana_url}
  • POST /api/exception_lists/items
  • POST /s/{space_id}/api/exception_lists/items
Auth

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

Note

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

Path parameters

space_id string optional

An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Request body

Exception list item's properties

description string required
entries union anyOf[] required
Any of:
type enum required
Values: match
field string · format: nonempty · min length: 1 required

A string that does not contain only whitespace characters

operator enum required
Values: excluded included
value string · format: nonempty · min length: 1 required

A string that does not contain only whitespace characters

expire_time string · format: date-time
item_id string · format: nonempty · min length: 1

A string that does not contain only whitespace characters

list_id string · format: nonempty · min length: 1 required

A string that does not contain only whitespace characters

meta object
name string · format: nonempty · min length: 1 required

A string that does not contain only whitespace characters

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.
Values: agnostic single
os_types enum[]
Values: linux macos windows
tags string[] · format: nonempty
type enum required
Values: simple

Responses

Successful response

application/json
_version string
comments object[] required
comment string · format: nonempty · min length: 1 required

A string that does not contain only whitespace characters

created_at string · format: date-time required
created_by string · format: nonempty · min length: 1 required

A string that does not contain only whitespace characters

id string · format: nonempty · min length: 1 required

A string that does not contain only whitespace characters

updated_at string · format: date-time
updated_by string · format: nonempty · min length: 1

A string that does not contain only whitespace characters

created_at string · format: date-time required
created_by string required
description string required
entries union anyOf[] required
Same options as entries
expire_time string · format: date-time
id string · format: nonempty · min length: 1 required

A string that does not contain only whitespace characters

item_id string · format: nonempty · min length: 1 required

A string that does not contain only whitespace characters

list_id string · format: nonempty · min length: 1 required

A string that does not contain only whitespace characters

meta object
name string · format: nonempty · min length: 1 required

A string that does not contain only whitespace characters

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.
Values: agnostic single
os_types enum[]
Values: linux macos windows
tags string[] · format: nonempty
tie_breaker_id string required
type enum required
Values: simple
updated_at string · format: date-time required
updated_by string required
Base URL
https://{kibana_url}