Skip to content
Hayonix

API reference · Pods

CPU, memory, disk, network and GPU series for a time range

GET/v1/pods/{pod_id}/telemetry
API keyworkload:readProject
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

Headers
HeaderRequiredDescription
AuthorizationyesBearer and your API key. The key implies its project.
X-Project-Idsession onlyThe project to act in, for console sessions. Requests with an API key leave it out.

Path parameters

  • pod_idstringrequired

    ID of the pod

    ID with prefix pod_

Query parameters

  • fromstring (date-time)

    Default: one hour ago

  • tostring (date-time)

    Default: now

  • resolutioninteger | null

    Seconds 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)

  • objectstringrequired

    Always `pod_telemetry`: the type of this object

    One ofpod_telemetry

  • pod_idstringrequired

    ID of the pod

  • resolution_secondsintegerrequired

    Seconds per point

  • sourcestringrequired

    Where the points come from: `raw` samples, or `minute` or `hour` summaries (coarser resolutions)

    One ofrawminutehour

  • limitsobjectrequired

    The pod’s resources, the 100% mark of the percentages

    Show 3 fields of limits
    • vcpusintegerrequired

      vCPUs the pod has

    • memory_bytesnumberrequired

      Memory the pod has, in bytes

    • gpu_countintegerrequired

      Number of GPUs

  • pointsarray of objectrequired

    One point per bucket, oldest first

    Show 14 fields of points
    • tstring (date-time)required

      Start of the bucket

    • covered_secondsnumberrequired

      Seconds of the bucket with samples (less when it was not running)

    • cpu_coresnumberrequired

      Average CPU use, in cores

    • cpu_percentnumberrequired

      Of the pod’s vCPUs

    • memory_bytes_avgnumberrequired

      Average memory use, in bytes

    • memory_bytes_maxnumberrequired

      Peak memory use, in bytes

    • memory_percentnumberrequired

      Average memory use as a percentage of the pod’s memory

    • disk_read_bytes_per_secondnumberrequired

      Average disk read rate, in bytes per second

    • disk_write_bytes_per_secondnumberrequired

      Average disk write rate, in bytes per second

    • network_rx_bytes_per_secondnumberrequired

      Average network receive rate, in bytes per second

    • network_tx_bytes_per_secondnumberrequired

      Average network send rate, in bytes per second

    • gpu_utilization_percentnumber | nullrequired

      Average GPU utilisation, 0–100; null when there are no GPU samples

    • gpu_memory_bytes_avgnumber | nullrequired

      Average GPU memory in use, in bytes; null without GPU samples

    • gpu_memory_bytes_maxnumber | nullrequired

      Peak GPU memory in use, in bytes; null without GPU samples

  • totalsobjectrequired

    Sums over the whole range

    Show 6 fields of totals
    • covered_secondsnumberrequired

      Seconds of the range with samples

    • cpu_core_secondsnumberrequired

      CPU used, in core-seconds

    • disk_read_bytesstringrequired

      Bytes read from disk (integer as a decimal string)

    • disk_write_bytesstringrequired

      Bytes written to disk (integer as a decimal string)

    • network_rx_bytesstringrequired

      Bytes received (integer as a decimal string)

    • network_tx_bytesstringrequired

      Bytes sent (integer as a decimal string)

  • as_ofstring (date-time)required

    When the response was computed

Example response
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:

Errors
StatusTypeWhen
400invalid_request_errorA parameter or body field is missing or not allowed; param names it.
401authentication_errorThe key or session is missing, revoked or expired.
403permission_errorThe credential lacks the permission this needs, or the organization is suspended.
404not_found_errorNo such resource in this project (an ID from another project is answered the same way).
429rate_limit_error rate_limitedToo many requests; retry after retry-after seconds.