Get value list privileges

Base URL: https://{kibana_url}

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

Auth

Returns the caller's authentication state and the Elasticsearch cluster, index, and application privileges for .lists and .items data streams in the current Kibana space. Use this to decide which list APIs (read vs all operations) are available before you create or import lists.

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Responses

Successful response

application/json

is_authenticated boolean required
listItems object required
lists object 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

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/privileges

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

{
  "is_authenticated": true,
  "listItems": {
    "application": {},
    "cluster": {
      "all": true,
      "manage": true,
      "manage_api_key": true,
      "manage_index_templates": true,
      "manage_ml": true,
      "manage_own_api_key": true,
      "manage_pipeline": true,
      "manage_security": true,
      "manage_transform": true,
      "monitor": true,
      "monitor_ml": true,
      "monitor_transform": true
    },
    "has_all_requested": true,
    "index": {
      ".items-default": {
        "all": true,
        "create": true,
        "create_doc": true,
        "create_index": true,
        "delete": true,
        "delete_index": true,
        "index": true,
        "maintenance": true,
        "manage": true,
        "monitor": true,
        "read": true,
        "view_index_metadata": true,
        "write": true
      }
    },
    "username": "elastic"
  },
  "lists": {
    "application": {},
    "cluster": {
      "all": true,
      "manage": true,
      "manage_api_key": true,
      "manage_index_templates": true,
      "manage_ml": true,
      "manage_own_api_key": true,
      "manage_pipeline": true,
      "manage_security": true,
      "manage_transform": true,
      "monitor": true,
      "monitor_ml": true,
      "monitor_transform": true
    },
    "has_all_requested": true,
    "index": {
      ".lists-default": {
        "all": true,
        "create": true,
        "create_doc": true,
        "create_index": true,
        "delete": true,
        "delete_index": true,
        "index": true,
        "maintenance": true,
        "manage": true,
        "monitor": true,
        "read": true,
        "view_index_metadata": true,
        "write": true
      }
    },
    "username": "elastic"
  }
}

{
  "error": "Bad Request",
  "message": "Unable to resolve list privileges: invalid or missing space context for this request",
  "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/privileges] is unauthorized for user, this action is granted by the Kibana privileges [lists-read]",
  "statusCode": 403
}

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