Get a value list item

Server: https://{kibana_url}

GET /api/lists/items

Api key auth Basic auth

Get the details of a value list item.

Query Parameters

Responses

Successful response

application/json

One of:

[] {} ListItem

_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
created_at string required: Autogenerated date of object creation.
created_by string required: Autogenerated value - user that created object.
id string · min: 1 required: Value list item's identifier.
list_id string · min: 1 required: Value list's identifier.
meta object: Placeholder for metadata about the value list item.
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 required: Autogenerated date of last object update.
updated_by string required: Autogenerated value - user that last updated object.
value string · min: 1 required: The value used to evaluate exceptions.

Invalid input data response

application/json

Unsuccessful authentication response

application/json

Not enough privileges response

application/json

List item not found response

application/json

Internal server error response

application/json

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET /api/lists/items

curl Shell

curl -X GET "https://{kibana_url}/api/lists/items"

Response

{
  "_version": "WzExLDFd",
  "@timestamp": "2025-01-08T05:16:25.882Z",
  "created_at": "2025-01-08T05:16:25.882Z",
  "created_by": "elastic",
  "id": "qN1XRJQBs4HAK3VQs3Gc",
  "list_id": "ip_list",
  "tie_breaker_id": "a9a34c02-a385-436e-86a0-02a3942f3537",
  "type": "ip",
  "updated_at": "2025-01-08T05:16:25.882Z",
  "updated_by": "elastic",
  "value": "127.0.0.2"
}

{
  "message": "Either \\\u0022list_id\\\u0022 or \\\u0022id\\\u0022 needs to be defined in the request",
  "status_code": 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 [GET /api/lists/items?id=qN1XRJQBs4HAK3VQs3Gc] is unauthorized for user, this action is granted by the Kibana privileges [lists-read]",
  "statusCode": 403
}

{
  "message": "list item id: \\\u0022foo\\\u0022 not found",
  "status_code": 404
}

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

Query Parameters { id , list_id , value , }

Responses

Query Parameters