API reference · Pods
CPU, memory, disk, network and GPU series for a time range
/v1/pods/{pod_id}/telemetry- TypeScript
client.pods.getTelemetry()- Python
client.pods.get_telemetry()- CLI
hayonix pods telemetry
Usage series for a time range (default: the last hour) at a chosen resolution, with totals over the range. Time when the pod was not running has no samples; see covered_seconds.
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/telemetry" \
-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
fromstring (date-time)Default: one hour ago
tostring (date-time)Default: now
resolutioninteger | nullSeconds per point: 10, 60, 300, 900, 3600, 21600 or 86400 (default: the finest giving at most 300 points)
Response
200 PodTelemetry — The series (raw, 1-minute or 1-hour tier by resolution)
objectstringrequiredAlways `pod_telemetry`: the type of this object
One of
pod_telemetrypod_idstringrequiredID of the pod
resolution_secondsintegerrequiredSeconds per point
sourcestringrequiredWhere the points come from: `raw` samples, or `minute` or `hour` summaries (coarser resolutions)
One of
rawminutehourlimitsobjectrequiredThe pod’s resources, the 100% mark of the percentages
ShowHide 3 fields of
limitsvcpusintegerrequiredvCPUs the pod has
memory_bytesnumberrequiredMemory the pod has, in bytes
gpu_countintegerrequiredNumber of GPUs
pointsarray of objectrequiredOne point per bucket, oldest first
ShowHide 14 fields of
pointststring (date-time)requiredStart of the bucket
covered_secondsnumberrequiredSeconds of the bucket with samples (less when it was not running)
cpu_coresnumberrequiredAverage CPU use, in cores
cpu_percentnumberrequiredOf the pod’s vCPUs
memory_bytes_avgnumberrequiredAverage memory use, in bytes
memory_bytes_maxnumberrequiredPeak memory use, in bytes
memory_percentnumberrequiredAverage memory use as a percentage of the pod’s memory
disk_read_bytes_per_secondnumberrequiredAverage disk read rate, in bytes per second
disk_write_bytes_per_secondnumberrequiredAverage disk write rate, in bytes per second
network_rx_bytes_per_secondnumberrequiredAverage network receive rate, in bytes per second
network_tx_bytes_per_secondnumberrequiredAverage network send rate, in bytes per second
gpu_utilization_percentnumber | nullrequiredAverage GPU utilisation, 0–100; null when there are no GPU samples
gpu_memory_bytes_avgnumber | nullrequiredAverage GPU memory in use, in bytes; null without GPU samples
gpu_memory_bytes_maxnumber | nullrequiredPeak GPU memory in use, in bytes; null without GPU samples
totalsobjectrequiredSums over the whole range
ShowHide 6 fields of
totalscovered_secondsnumberrequiredSeconds of the range with samples
cpu_core_secondsnumberrequiredCPU used, in core-seconds
disk_read_bytesstringrequiredBytes read from disk (integer as a decimal string)
disk_write_bytesstringrequiredBytes written to disk (integer as a decimal string)
network_rx_bytesstringrequiredBytes received (integer as a decimal string)
network_tx_bytesstringrequiredBytes sent (integer as a decimal string)
as_ofstring (date-time)requiredWhen the response was computed
Example response
{
"object": "pod_telemetry",
"pod_id": "string",
"resolution_seconds": 1,
"source": "raw",
"limits": {
"vcpus": 1,
"memory_bytes": 1.5,
"gpu_count": 1
},
"points": [
{
"t": "2026-01-01T00:00:00.000Z",
"covered_seconds": 1.5,
"cpu_cores": 1.5,
"cpu_percent": 1.5,
"memory_bytes_avg": 1.5,
"memory_bytes_max": 1.5,
"memory_percent": 1.5,
"disk_read_bytes_per_second": 1.5,
"disk_write_bytes_per_second": 1.5,
"network_rx_bytes_per_second": 1.5,
"network_tx_bytes_per_second": 1.5,
"gpu_utilization_percent": 1.5,
"gpu_memory_bytes_avg": 1.5,
"gpu_memory_bytes_max": 1.5
}
],
"totals": {
"covered_seconds": 1.5,
"cpu_core_seconds": 1.5,
"disk_read_bytes": "string",
"disk_write_bytes": "string",
"network_rx_bytes": "string",
"network_tx_bytes": "string"
},
"as_of": "2026-01-01T00:00:00.000Z"
}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. |