Get agent setup info

Server: https://{kibana_url}

GET /api/fleet/agents/setup
GET /s/{space_id}/api/fleet/agents/setup

Refer to Spaces for more information.

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

[Required authorization] Route required privileges: fleet-agents-read OR fleet-agent-policies-read OR fleet-settings-read OR fleet-setup.

Responses

Fleet setup status

application/json

Bad Request

application/json

Examples

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

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET /api/fleet/agents/setup

curl Shell

curl -X GET "https://{kibana_url}/api/fleet/agents/setup"

Response

{
  "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
}