Update a value list

Base URL: https://{kibana_url}

PUT /api/lists
PUT /s/{space_id}/api/lists

Auth

Update a value list using the list id. The original list is replaced, and all unspecified fields are deleted.

Note

You cannot modify the id value.

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

Value list's properties

_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.
description string · format: nonempty · min length: 1 required: Describes the value list.
id string · format: nonempty · min length: 1 required: Value list's identifier.
meta object: Placeholder for metadata about the value list.
name string · format: nonempty · min length: 1 required: Value list's name.
version integer · min: 1: The document version number.

Responses

Successful response

application/json

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

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

List not found response

application/json

message string required
status_code integer required

Internal server error response

application/json

message string required
status_code integer required

Path parameters

Request body { }

Responses

Request body