Initiate Fleet setup

Base URL: https://{kibana_url}

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

Refer to Spaces for more information.

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

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

Base URL: https://{kibana_url}

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
}