Get value list privileges

Server: https://{kibana_url}

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

Refer to Spaces for more information.

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.

Responses

Successful response

application/json

Invalid input data response

application/json

Unsuccessful authentication response

application/json

Not enough privileges response

application/json

Internal server error response

application/json

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET /api/lists/privileges

curl Shell

curl -X GET "https://{kibana_url}/api/lists/privileges"

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
}