API reference · Pods
The pod’s timeline (oldest first): what the platform did and what its host reported
/v1/pods/{pod_id}/events- TypeScript
client.pods.listEvents()- Python
client.pods.list_events()- CLI
hayonix pods events
Events such as placement, waiting for capacity, preemption, start and stop requests, reconfiguration and failures, oldest first. Events are kept after the container is gone.
Project API key (Authorization: Bearer sk_…), or a console session. Requires the workload: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/pods/pod_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
pod_idstringrequiredID of the pod
ID with prefix pod_
Query parameters
limitintegerEvents per page, 1–200 (default 100)
1–200
cursorstring`next_cursor` of the previous page (events are oldest first)
up to 200 characters
Response
200 a page of results — A page of events
The items of this page.
ShowHide 7 fields of
dataobjectstringrequiredAlways `pod_event`: the type of this object
One of
pod_eventidstringrequiredUnique ID
typestringrequiredWhat happened, for example `placed`, `waiting`, `preempted`, `start_requested`, `stop_requested`, `reconfigured` or `terminated`
severitystringrequired`info`: routine. `warning`: may need attention. `error`: something failed.
One of
infowarningerrormessagestringrequiredOne sentence for people
dataobject | nullrequiredDetails; their shape depends on the kind of entry
occurred_atstring (date-time)requiredWhen it happened (ISO 8601, UTC)
next_cursorstring | nullrequiredPass as `cursor` for the next page; null on the last page.
Example response
{
"data": [
{
"object": "pod_event",
"id": "string",
"type": "placed",
"severity": "info",
"message": "string",
"data": {},
"occurred_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. |