Initiate Fleet setup

Base URL: https://{kibana_url}

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

Refer to Spaces for more information.

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

Header parameters

Responses

Fleet setup completed

application/json

Bad Request

application/json

Internal Server Error

application/json

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
}