/quay/repositories/packages

POST /api/quay/repositories/packages

Price: 1 credit

Get the installed-package inventory Clair indexed for one Quay.io image tag

How to use it

Read the package inventory of one tag as a single report — the software bill of materials Clair built while indexing the image, covering both distro packages and language dependencies vendored into the binary. `added_by_layer_digest` says which layer introduced each package. An empty `packages` list is only meaningful when `scan_status` is 'scanned'; 'queued' and 'unsupported' mean no inventory exists yet, not that the image is empty.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• repo string required — Repository as 'namespace/name' or its quay.io URL (examples: "keycloak/keycloak", "argoproj/argocd"; minLength: 1)
• tag string — Tag to read (default: "latest"; examples: "latest", "26.4"; minLength: 1)
• platform string — Which per-platform image of a multi-arch tag to read, as 'os/architecture' or 'os/architecture/variant'. Ignored when the tag is a single-platform image (default: "linux/amd64"; examples: "linux/amd64", "linux/arm64", "linux/arm/v7"; minLength: 1)

Response

• @type string (default: "QuayPackageInventory")
• alias string required
• repository string required
• tag string required
• url string required
• manifest_digest string required
• platform string (default: "")
• scan_status string (default: "")
• is_scanned boolean (default: false)
• indexed_by_version integer nullable
• package_count integer (default: 0)
• packages array (default: [])
  • @type string (default: "QuayPackage")
  • name string required
  • version string (default: "")
  • version_format string (default: "")
  • namespace string (default: "")
  • added_by_layer_digest string (default: "")
  • cve_ids array (default: [])
  • base_scores array (default: [])
  • vulnerability_count integer (default: 0)

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 — Repository, tag, or that platform of the tag does not exist 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.