Get agent setup info

Base URL: https://{kibana_url}

GET /api/fleet/agents/setup

Auth

Get the current Fleet setup status, including whether Fleet is ready to enroll agents and which requirements or optional features are missing.

Required privileges

Privileges fleet-agents-read or fleet-agent-policies-read or fleet-settings-read or fleet-setup

Responses

Fleet setup status

application/json

is_action_secrets_storage_enabled boolean
is_secrets_storage_enabled boolean
is_space_awareness_enabled boolean
is_ssl_secrets_storage_enabled boolean
isReady boolean required
missing_optional_features enum[] · max items: 1 required: Values: encrypted_saved_object_encryption_key_required
missing_requirements enum[] · max items: 5 required: Values: security_required tls_required api_keys fleet_admin_user fleet_server
package_verification_key_id string

Bad Request

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/fleet/agents/setup

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

Fleet is not ready — a Fleet Server and API keys are required

{
  "is_action_secrets_storage_enabled": false,
  "is_secrets_storage_enabled": false,
  "is_space_awareness_enabled": false,
  "is_ssl_secrets_storage_enabled": false,
  "isReady": false,
  "missing_optional_features": [
    "encrypted_saved_object_encryption_key_required"
  ],
  "missing_requirements": [
    "fleet_server",
    "api_keys"
  ]
}

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