GET /api/fleet/check-permissions
Api key auth Basic auth

Spaces method and path for this operation:

get /s/{space_id}/api/fleet/check-permissions

Refer to Spaces for more information.

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

Query parameters

  • fleetServerSetup boolean

    When true, check Fleet Server setup privileges in addition to standard Fleet privileges

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • error string

      Values are MISSING_SECURITY, MISSING_PRIVILEGES, or MISSING_FLEET_SERVER_SETUP_PRIVILEGES.

    • success boolean Required
  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • attributes Required
    • error string
    • errorType string
    • message string Required
    • statusCode number
GET /api/fleet/check-permissions 
curl \
 --request GET 'https://localhost:5601/api/fleet/check-permissions' \
 --header "Authorization: $API_KEY"
Response examples (200)
The current user is missing Fleet privileges 
{
  "error": "MISSING_PRIVILEGES",
  "success": false
}
The current user has all required Fleet permissions 
{
  "success": true
}
Response examples (400)
Example of a generic error response 
{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}