Skip to Content
Podyard

USAGE

View your account's consumption and quota usage.

USAGE

GET /v1/usage returns your account's consumption for the current billing period.

Base: https://api.podyard.dev/v1


GET /v1/usage — Get usage metrics

Headers: Authorization: Bearer <key>.

Response 200:

{
  "podHours": 12.5,
  "storageGiB": 2.1,
  "execCount": 847,
  "snapshotCount": 3,
  "concurrentPods": 2,
  "maxConcurrentPods": 5,
  "period": {
    "start": "2026-01-01T00:00:00Z",
    "end": "2026-01-31T23:59:59Z"
  }
}
FieldTypeDescription
podHoursnumberCumulative pod-hours consumed this period
storageGiBnumberCurrent storage usage in GiB
execCountnumberTotal exec calls this period
snapshotCountnumberActive snapshot count
concurrentPodsintCurrently running pods
maxConcurrentPodsintPlan's concurrent pod limit
periodobjectBilling period start/end (ISO-8601 UTC)

Errors: 401 unauthorized (invalid or missing key).

[DECIDE] — The exact billing unit (pod-hours vs. flat monthly) is not yet settled. podHours is the primary metered unit in the current implementation.

WHERE_TO_GO_NEXT

  • Limits — plan limit values.
  • Keys — manage API keys.
  • Errors — full error code reference.