/ghcr/packages

POST /api/ghcr/packages

Price: 10 credits

Get a GitHub Container Registry package by namespace and package name

How to use it

Resolve one ghcr.io container package. The package name is not the repository name — home-assistant/core publishes home-assistant, hassfest and others — so pass the name from the pull reference, and note it may itself contain a slash ('drey/nginx/nginx' is namespace drey, package nginx/nginx). `source_repository` is filled only when the publisher linked one, which is also what decides whether the GitHub page has a repository URL at all. `download_count` is the exact lifetime total; per-version totals come from packages/versions.

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", "ghcr.io/nginxinc/nginx-unprivileged", "https://github.com/home-assistant/core/pkgs/container/home-assistant"; minLength: 1)

Response

• @type string (default: "GhcrPackage")
• alias string required
• namespace string required
• name string required
• url string required
• pull_reference string required
• is_public boolean (default: false)
• latest_version_tag string (default: "")
• last_published_at integer nullable
• download_count integer nullable
• source_repository string (default: "")
• source_repository_url string (default: "")
• recent_versions array (default: [])
  • @type string (default: "GhcrPackageVersionRef")
  • version_id string required
  • url string required
  • tags array (default: [])

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 public container package with this namespace and name 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.