Initiate Fleet setup

Auth

Initialize Fleet. This endpoint is used by Elastic Agents to trigger Fleet setup. Safe to call multiple times; subsequent calls are idempotent.

Required authorization

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

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

kbn-xsrf string required: A required header to protect against CSRF attacks

Fleet setup completed

application/json

Bad Request

application/json

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/fleet/agents/setup

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/agents/setup" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

Fleet setup initialized successfully with no non-fatal errors

{
  "isInitialized": true,
  "nonFatalErrors": []
}

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