Fleet Server health check

Base URL: https://{kibana_url}

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

Auth

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: Kibana's anti Cross-Site Request Forgery token. Can be any string value.

Request body

host string deprecated
id string required

Responses

application/json

host string deprecated
id string: Fleet Server host id
status string

Generic Error

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/fleet/health_check
{
  "id": "string"
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/fleet/health_check" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string"
  }'

Generated from the API spec

Response

{
  "host": "string",
  "id": "string",
  "status": "string"
}

Generated from the API spec

{
  "error": "string",
  "message": "string",
  "statusCode": 0
}

Generated from the API spec

Path parameters

Header parameters

Request body { }

Responses

Request body