Create list data streams

Base URL: https://{kibana_url}

POST /api/lists/index

Auth Deprecated

DEPRECATED. deprecated: true is set on this operation. Value list backing data streams for the space are now created as part of supported workflows; calling this explicitly is rarely required. WARNING: Do not use for new integrations. Prefer the UI or the list and list-item APIs after confirming indices exist with GET /api/lists/index.

Creates the .lists and .items data streams in the current Kibana space.

Responses

Successful response

application/json

acknowledged 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 exists 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

POST kbn:/api/lists/index

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

{
  "acknowledged": true
}

{
  "message": "Indices exist but the request could not be completed for the current space. Check that Elasticsearch and Kibana privileges allow index creation for lists.",
  "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]\n",
  "statusCode": 401
}

{
  "error": "Forbidden",
  "message": "API [POST /api/lists/index] is unauthorized for user, this action is granted by the Kibana privileges [lists-all]",
  "statusCode": 403
}

{
  "message": "data stream: \\\u0022.lists-default\\\u0022 and \\\u0022.items-default\\\u0022 already exists",
  "status_code": 409
}

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