Get agent setup info

Base URL: https://{kibana_url}

GET /api/fleet/agents/setup

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

Required authorization

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>

Responses

Fleet setup status

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