Get value lists

Base URL: https://{kibana_url}

GET /api/lists/_find
GET /s/{space_id}/api/lists/_find

Refer to Spaces for more information.

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

Authentication

Query parameters

Responses

Successful response

application/json

cursor string · format: nonempty · min length: 1 required
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/_find

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/lists/_find" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

{
  "cursor": "WzIwLFsiZjU1MDgxODgtYjFlOS00ZTZlLTk2NjItZDAzOWE3ZDg5ODk5Il1d",
  "data": [
    {
      "_version": "WzAsMV0=",
      "@timestamp": "2025-01-08T04:47:34.273Z\n",
      "created_at": "2025-01-08T04:47:34.273Z\n",
      "created_by": "elastic",
      "description": "This list describes bad internet ip",
      "id": "ip_list",
      "immutable": false,
      "name": "Simple list with an ip",
      "tie_breaker_id": "f5508188-b1e9-4e6e-9662-d039a7d89899",
      "type": "ip",
      "updated_at": "2025-01-08T04:47:34.273Z\n",
      "updated_by": "elastic",
      "version": 1
    }
  ],
  "page": 1,
  "per_page": 20,
  "total": 1
}

{
  "error": "Bad Request",
  "message": "[request query]: page: Expected number, received nan",
  "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/_find?page=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
}