Initiate Fleet setup

Base URL: https://{kibana_url}

POST /api/fleet/setup
POST /s/{space_id}/api/fleet/setup

Auth

Initialize Fleet and create the necessary Elasticsearch resources for Fleet to operate. Safe to call multiple times (idempotent). Returns the initialization status and any non-fatal errors encountered during setup.

Required privileges

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

Path parameters

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.

Header parameters

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

Responses

Fleet setup completed

application/json

isInitialized boolean required
nonFatalErrors object[] · max items: 10000 required

Bad Request

application/json

attributes object required
error string
errorType string
message string required
statusCode number

Internal Server Error

application/json

message string required

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/fleet/setup

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

Fleet initialized successfully with no non-fatal errors

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

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

{
  "error": "Internal Server Error",
  "message": "An error message describing what went wrong",
  "statusCode": 500
}