/ghcr/versions

POST /api/ghcr/versions

Price: 5 credits

Get one published version of a GitHub Container Registry package

How to use it

Read one version of a ghcr.io package: every tag pointing at it, the per-platform child digests of a multi-arch build, and the download breakdown GitHub publishes nowhere else (`download_count_last_30_days`, `_last_week`, `_today`). Entries with `is_attestation` true are build provenance rather than runnable images. `digest` is filled only when the version's own tag is the digest form; for a normally tagged version take the digest from packages/versions, or read the per-platform digests here.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• package string required — Package as 'namespace/package', its ghcr.io pull reference, or its GitHub Packages URL (examples: "home-assistant/home-assistant", "nginxinc/nginx-unprivileged"; minLength: 1)
• version_id string required — The numeric version id, as returned by packages/versions in `version_id` (examples: "1230779461", "380163202"; minLength: 1)

Response

• @type string (default: "GhcrVersion")
• version_id string required
• alias string required
• package string required
• namespace string required
• url string required
• pull_reference string (default: "")
• digest string (default: "")
• tags array (default: [])
• is_latest boolean (default: false)
• source_repository string (default: "")
• download_count integer nullable
• download_count_last_30_days integer nullable
• download_count_last_week integer nullable
• download_count_today integer nullable
• platforms array (default: [])
  • @type string (default: "GhcrVersionPlatform")
  • platform string required
  • os string (default: "")
  • architecture string (default: "")
  • variant string (default: "")
  • digest string (default: "")
  • is_attestation boolean (default: false)

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No such version id under this package Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.