Check permissions

Base URL: https://{kibana_url}

GET /api/fleet/check-permissions

Check whether the current user has the required permissions to use Fleet. Optionally verifies Fleet Server setup privileges.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Query parameters

Responses

Successful response

application/json

Bad Request

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/fleet/check-permissions

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/fleet/check-permissions" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

The current user is missing Fleet privileges

{
  "error": "MISSING_PRIVILEGES",
  "success": false
}

{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}