API reference · Clusters
The cluster’s timeline, oldest first
/v1/clusters/{cluster_id}/events- TypeScript
client.clusters.listEvents()- Python
client.clusters.list_events()- CLI
hayonix clusters events
Created, running, degraded (which member, and why), stopped and deleted, with one sentence each.
Project API key (Authorization: Bearer sk_…), or a console session. Requires the cluster:read permission (a key's scope, or a role that includes it).
Examples
The samples read API_KEY and API_BASE_URL from the environment (see Setup). Values are examples.
curl -sS "$API_BASE_URL/clusters/clu_01jc5zq4m8k3v6x9t2w7r0b1e4/events" \
-H "Authorization: Bearer $API_KEY"Request
| Header | Required | Description |
|---|---|---|
Authorization | yes | Bearer and your API key. The key implies its project. |
X-Project-Id | session only | The project to act in, for console sessions. Requests with an API key leave it out. |
Path parameters
cluster_idstringrequiredID of the cluster
ID with prefix clu_
Query parameters
limitinteger1–200, default 50
1–200
cursorstring`next_cursor` of the previous page
up to 200 characters
Response
200 a page of results — A page of events
The items of this page.
ShowHide 7 fields of
dataobjectstringrequiredAlways `cluster_event`: the type of this object
One of
cluster_eventidstringrequiredUnique ID (`cle_…`)
ID with prefix cle_
typestringrequiredcreated, running, degraded, stopped, deleted
severitystringrequiredHow much it matters
One of
infowarningerrormessagestringrequiredOne sentence for people
rankinteger | nullrequiredThe member it is about, when it is about one
created_atstring (date-time)requiredWhen it was created (ISO 8601, UTC)
next_cursorstring | nullrequiredPass as `cursor` for the next page; null on the last page.
Example response
{
"data": [
{
"object": "cluster_event",
"id": "cle_01jc5zq4m8k3v6x9t2w7r0b1e4",
"type": "string",
"severity": "info",
"message": "string",
"rank": 1,
"created_at": "2026-01-01T00:00:00.000Z"
}
],
"next_cursor": "string"
}Errors
Errors use the standard envelope. What this operation can answer:
| Status | Type | When |
|---|---|---|
400 | invalid_request_error | A parameter or body field is missing or not allowed; param names it. |
401 | authentication_error | The key or session is missing, revoked or expired. |
403 | permission_error | The credential lacks the permission this needs, or the organization is suspended. |
404 | not_found_error | No such resource in this project (an ID from another project is answered the same way). |
429 | rate_limit_error rate_limited | Too many requests; retry after retry-after seconds. |