Internal site. Jolli authentication required to view.
Skip to Content
API ReferencePlatformGET /v0/cluster/events

List Cluster Events

GET/v0/cluster/eventsPlatform

Try it

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

  • JSON web token (JWT) or API keyBearer token

Response

200application/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.
500application/json
  • object
    Information returned by REST API endpoints on error.
    • detailsobjectrequired
      Detailed error metadata. The contents of this field is determined by `error_code`.
    • error_codestringrequired
      Error code is a string that specifies this error type.
    • messagestringrequired
      Human-readable error message.
501application/json
  • object
    Information returned by REST API endpoints on error.
    • detailsobjectrequired
      Detailed error metadata. The contents of this field is determined by `error_code`.
    • error_codestringrequired
      Error code is a string that specifies this error type.
    • messagestringrequired
      Human-readable error message.
Request
curl -X GET 'https://api.example.com/v0/cluster/events' \ -H 'Authorization: Bearer YOUR_TOKEN'
Response
[]