Skip to content
Hayonix

API reference · Schema

PodVolumeSummary

  • idstringrequired

    Unique ID

  • namestringrequired

    Its name

  • kindstringrequired

    `pod`: this pod’s own volume. `network`: a network volume it mounts. (`cluster` volumes are never mounted by pods.)

    One ofpodnetworkcluster

  • size_gbintegerrequired

    Size in GB

  • pinned_to_hostbooleanrequired

    The volume lives on one host; pods using it run there

  • used_bytesinteger | nullrequired

    Space the volume uses on its host, as last measured; null until a host has measured it

  • usage_observed_atstring (date-time) | nullrequired

    When `used_bytes` was measured

Example
{
  "id": "string",
  "name": "string",
  "kind": "pod",
  "size_gb": 1,
  "pinned_to_host": true,
  "used_bytes": 1,
  "usage_observed_at": "2026-01-01T00:00:00.000Z"
}