Check Fleet Server health

POST /api/fleet/health_check

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

Headers

kbn-xsrf string Required

A required header to protect against CSRF attacks

application/json

Body

id string Required

Responses

200 application/json
Hide response attributes Show response attributes object
- host_id string
- name string
- status string Required
400 application/json
Hide response attributes Show response attributes object
- error string
- message string Required
- statusCode number
404 application/json
Hide response attributes Show response attributes object
- error string
- message string Required
- statusCode number

POST /api/fleet/health_check

curl \
 --request POST https://localhost:5601/api/fleet/health_check \
 --header "Content-Type: application/json" \
 --header "kbn-xsrf: true" \
 --data '{"id":"string"}'

Request examples

# Headers
kbn-xsrf: true

# Payload
{
  "id": "string"
}

Response examples (200)

{
  "host_id": "string",
  "name": "string",
  "status": "string"
}

Response examples (400)

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

Response examples (404)

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