Get value list items

Base URL: https://{kibana_url}

GET /api/lists/items/_find

Get all value list items in the specified list.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Query parameters

Responses

Successful response

application/json

cursor string · format: nonempty · min length: 1 required: Returns the items that come after the last item 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 items are sorted and returned correctly.
data object[] required
page integer · min: 0 required
per_page integer · min: 0 required
total integer · min: 0 required

Invalid input data response

application/json

Unsuccessful authentication response

application/json

Not enough privileges response

application/json

Internal server error response

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/lists/items/_find?list_id=21b01cfb-058d-44b9-838c-282be16c91cd

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/lists/items/_find?list_id=21b01cfb-058d-44b9-838c-282be16c91cd" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

{
  "cursor": "WzIwLFsiYjU3Yzc2MmMtMzAzNi00NjVjLTliZmItN2JmYjVlNmU1MTVhIl1d",
  "data": [
    {
      "_version": "WzAsMV0=",
      "@timestamp": "2025-01-08T04:59:06.154Z",
      "created_at": "2025-01-08T04:59:06.154Z",
      "created_by": "elastic",
      "id": "21b01cfb-058d-44b9-838c-282be16c91cc",
      "list_id": "ip_list",
      "tie_breaker_id": "b57c762c-3036-465c-9bfb-7bfb5e6e515a",
      "type": "ip",
      "updated_at": "2025-01-08T04:59:06.154Z",
      "updated_by": "elastic",
      "value": "127.0.0.1"
    }
  ],
  "page": 1,
  "per_page": 20,
  "total": 1
}

{
  "error": "Bad Request,",
  "message": "[request query]: list_id: Required",
  "statusCode": "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/_find?list_id=ip_list\u0026page=1\u0026per_page=20] is unauthorized for user, this action is granted by the Kibana privileges [lists-read]",
  "statusCode": 403
}

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