Get the latest output health

Base URL: https://{kibana_url}

GET /api/fleet/outputs/{outputId}/health

Get the latest health status of an output by ID.

Required authorization

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Responses

Successful response

application/json

Bad Request

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/fleet/outputs/OUTPUT_ID/health

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/fleet/outputs/${OUTPUT_ID}/health" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

The latest health status of a Fleet output

{
  "message": "",
  "state": "HEALTHY",
  "timestamp": "2024-01-15T10:00:00.000Z"
}

{
  "error": "Bad Request",
  "message": "An error message describing what went wrong",
  "statusCode": 400
}