Skip to main content

List Cluster Events

Required role: read or higher.

Retrieve a list of retained cluster monitor events ordered from most recent to least recent.

The returned events only have limited details, the full details can be retrieved using the GET /v0/cluster/events/<event-id> endpoint.

Cluster monitor events are collected at a periodic interval (every 10s), however only every 10 minutes or if the overall health changes, does it get inserted into the database (and thus, served by this endpoint). At most 1000 events are retained (newest first), and events older than 72h are deleted. The latest event, if it already exists, is never cleaned up.

Responses
200
Schema — OPTIONAL
object[]
all_healthy boolean

Whether every service was healthy when this event was recorded. Says nothing about the cluster now: for that, read stale alongside it or call GET /v0/cluster_healthz.

api_resources_info string — OPTIONAL
api_self_info string — OPTIONAL
api_status string

Possible values: [InitialUnhealthy, Unhealthy, Healthy]

compiler_resources_info string — OPTIONAL
compiler_self_info string — OPTIONAL
compiler_status string

Possible values: [InitialUnhealthy, Unhealthy, Healthy]

id uuid

Cluster monitor event identifier.

recorded_at date-time
runner_resources_info string — OPTIONAL
runner_self_info string — OPTIONAL
runner_status string

Possible values: [InitialUnhealthy, Unhealthy, Healthy]

stale boolean — OPTIONAL

Whether the monitor stopped writing, making the statuses below the last recorded ones. Reported for the latest event only: older events are old by design.

500
Schema — OPTIONAL
details

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.

501
Schema — OPTIONAL
details

Detailed error metadata. The contents of this field is determined by error_code.

error_code string

Error code is a string that specifies this error type.

message string

Human-readable error message.