Skip to main content

Check Cluster Health

Required role: read or higher.

Determine the latest cluster health via the latest cluster monitor event. Each service's unchanged_since reports the approximate time it last transitioned between healthy and unhealthy, bounded by event retention.

Responses
200

All services healthy

Schema OPTIONAL
all_healthy boolean

Whether every service is healthy.

api object

Health of a single service derived from the retained cluster monitor events.

checked_at date-time

Timestamp of the most recent cluster monitor event.

healthy boolean

Whether the service passed its most recent health check.

message string

Human-readable report from the most recent health check.

unchanged_since date-time

Approximate time the service last transitioned between healthy and unhealthy: the timestamp of the oldest retained consecutive cluster monitor event with the same healthy conclusion. Bounded by event retention.

compiler object

Health of a single service derived from the retained cluster monitor events.

checked_at date-time

Timestamp of the most recent cluster monitor event.

healthy boolean

Whether the service passed its most recent health check.

message string

Human-readable report from the most recent health check.

unchanged_since date-time

Approximate time the service last transitioned between healthy and unhealthy: the timestamp of the oldest retained consecutive cluster monitor event with the same healthy conclusion. Bounded by event retention.

runner object

Health of a single service derived from the retained cluster monitor events.

checked_at date-time

Timestamp of the most recent cluster monitor event.

healthy boolean

Whether the service passed its most recent health check.

message string

Human-readable report from the most recent health check.

unchanged_since date-time

Approximate time the service last transitioned between healthy and unhealthy: the timestamp of the oldest retained consecutive cluster monitor event with the same healthy conclusion. Bounded by event retention.

503

One or more services unhealthy

Schema OPTIONAL
all_healthy boolean

Whether every service is healthy.

api object

Health of a single service derived from the retained cluster monitor events.

checked_at date-time

Timestamp of the most recent cluster monitor event.

healthy boolean

Whether the service passed its most recent health check.

message string

Human-readable report from the most recent health check.

unchanged_since date-time

Approximate time the service last transitioned between healthy and unhealthy: the timestamp of the oldest retained consecutive cluster monitor event with the same healthy conclusion. Bounded by event retention.

compiler object

Health of a single service derived from the retained cluster monitor events.

checked_at date-time

Timestamp of the most recent cluster monitor event.

healthy boolean

Whether the service passed its most recent health check.

message string

Human-readable report from the most recent health check.

unchanged_since date-time

Approximate time the service last transitioned between healthy and unhealthy: the timestamp of the oldest retained consecutive cluster monitor event with the same healthy conclusion. Bounded by event retention.

runner object

Health of a single service derived from the retained cluster monitor events.

checked_at date-time

Timestamp of the most recent cluster monitor event.

healthy boolean

Whether the service passed its most recent health check.

message string

Human-readable report from the most recent health check.

unchanged_since date-time

Approximate time the service last transitioned between healthy and unhealthy: the timestamp of the oldest retained consecutive cluster monitor event with the same healthy conclusion. Bounded by event retention.