Check Fleet Server health

POST /api/fleet/health_check
Api key auth Basic auth

Spaces method and path for this operation:

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

Refer to Spaces for more information.

[Required authorization] Route required privileges: 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
    • errorType string
    • message string Required
    • statusCode number
  • 404 application/json
    Hide response attributes Show response attributes object
    • error string
    • errorType string
    • message string Required
    • statusCode number
POST /api/fleet/health_check 
curl \
 --request POST 'https://localhost:5601/api/fleet/health_check' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "kbn-xsrf: true" \
 --data '{"id":"string"}'