Skip to Content
API ReferencePlatformList Cluster Events

List Cluster Events

GET/v0/cluster/events
Authentication

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.

Authentication

SchemeTypeDetails
JSON web token (JWT) or API keyBearer tokenAuthorization header · Use a JWT token obtained via an OAuth2/OIDC login workflow or an API key obtained via the `/v0/api-keys` endpoint.

Response

application/json
  • ClusterMonitorEventSelectedInfo[]
    • object
      Cluster monitor event information which has a selected subset of optional fields. If an optional field is not selected (i.e., is `None`), it will not be serialized.
Request
curl -X GET '/v0/cluster/events' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
[]