Check Fleet Server health

Base URL: https://{kibana_url}

POST /api/fleet/health_check

Auth

Check the health status of a Fleet Server instance by its host ID. Returns the server status and name if available.

Required authorization

Privileges fleet-settings-all

Header parameters

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

Request body

id string required

Responses

Successful health check response

application/json

host_id string
name string
status string required

Bad Request

application/json

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

Not Found

application/json

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

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Check the health of a Fleet Server instance by its host ID

Console Kibana Dev Tools

POST kbn:/api/fleet/health_check
{
  "id": "fleet-server-host-id-1"
}

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": "fleet-server-host-id-1"
  }'

Generated from the API spec

Response

Fleet Server is online and healthy

{
  "name": "fleet-server-1",
  "status": "ONLINE"
}

{
  "error": "Bad Request",
  "message": "The requested host id fleet-server-host-id-1 does not have associated host urls.",
  "statusCode": 400
}

{
  "error": "Not Found",
  "message": "The requested host id fleet-server-host-id-1 does not exist.",
  "statusCode": 404
}

Required authorization

Header parameters

Request body { }

Responses

Request body