Get value lists

Base URL
https://{kibana_url}
  • GET /api/lists/_find
  • GET /s/{space_id}/api/lists/_find
Auth

Get a paginated subset of value lists. By default, the first page is returned, with 20 results per page.

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.

Query parameters

page integer

The page number to return.

per_page integer

The number of value lists to return per page.

sort_field string · format: nonempty · min length: 1

Determines which field is used to sort the results.

Example: name
sort_order enum

Determines the sort order, which can be desc or asc

Values: desc asc
cursor string · format: nonempty · min length: 1

Returns the lists that come after the last lists returned in the previous call (use the cursor value returned in the previous call). This parameter uses the tie_breaker_id field to ensure all lists are sorted and returned correctly.

Example: WzIwLFsiYjU3Yzc2MmMtMzAzNi00NjVjLTliZmItN2JmYjVlNmU1MTVhIl1d
filter string

Filters the returned results according to the value of the specified field, using the

Example: value:127.0.0.1

Responses

Successful response

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

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

@timestamp string · format: date-time
created_at string · format: date-time required

Autogenerated date of object creation.

created_by string required

Autogenerated value - user that created object.

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

Describes the value list.

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

Value list's identifier.

immutable boolean required
meta object

Placeholder for metadata about the value list.

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

Value list's name.

tie_breaker_id string required

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

type enum 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)
Values: binary boolean byte date date_nanos date_range double double_range float float_range geo_point geo_shape
updated_at string · format: date-time 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 number.

page integer · min: 0 required
per_page integer · min: 0 required
total integer · min: 0 required

Invalid input data response

application/json
One of:
error string required
message string required
statusCode integer required

Unsuccessful authentication response

application/json
error string required
message string required
statusCode integer required

Not enough privileges response

application/json
error string required
message string required
statusCode integer required

Internal server error response

application/json
message string required
status_code integer required
Base URL
https://{kibana_url}