GET /api/fleet/outputs/{outputId}/health
Api key auth Basic auth

Spaces method and path for this operation:

get /s/{space_id}/api/fleet/outputs/{outputId}/health

Refer to Spaces for more information.

Get the latest health status of an output by ID.

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

Path parameters

  • outputId string Required

    The ID of the output

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • message string Required

      long message if unhealthy

    • state string Required

      state of output, HEALTHY or DEGRADED

    • timestamp string Required

      timestamp of reported state
  • 400 application/json

    Bad Request

    Hide response attributes Show response attributes object
    • attributes Required
    • error string
    • errorType string
    • message string Required
    • statusCode number
GET /api/fleet/outputs/{outputId}/health 
curl \
 --request GET 'https://localhost:5601/api/fleet/outputs/{outputId}/health' \
 --header "Authorization: $API_KEY"
Response examples (200)
The latest health status of a Fleet output 
{
  "message": "",
  "state": "HEALTHY",
  "timestamp": "2024-01-15T10:00:00.000Z"
}
Response examples (400)
Example of a generic error response 
{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}