Check Fleet Server health

Server: https://{kibana_url}

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

Refer to Spaces for more information.

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

[Required authorization] Route required privileges: fleet-settings-all.

Request

id string required

Responses

Successful health check response

application/json

Bad Request

application/json

Not Found

application/json

Examples

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

Request Console 1 / 2 languages

Console Kibana Dev Tools

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

curl Shell

curl -X POST "https://{kibana_url}/api/fleet/health_check" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "fleet-server-host-id-1"
}'

Response

{
  "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
}