Get status of value list data streams

Base URL: https://{kibana_url}

GET /api/lists/index

Auth

Verify that .lists and .items data streams exist.

Responses

Successful response

application/json

list_index boolean required
list_item_index boolean 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

List data stream(s) 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

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/lists/index

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

{
  "list_index": true,
  "list_item_index": true
}

{
  "message": "Unable to read value list data stream status for this space",
  "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/index] is not authorized; list read permissions are required",
  "statusCode": 403
}

{
  "message": "Value list backing indices were not found for this space",
  "status_code": 404
}

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