/dockerhub/repositories

POST /api/dockerhub/repositories

Price: 1 credit

Get Docker Hub repository details by namespace/name, official image name, or repository URL

How to use it

Get full details of a Docker Hub repository (container image) by 'namespace/name', a bare official image name (resolved under 'library'), or a Docker Hub URL. Returns name, namespace, description, full description, star and pull counts, storage size, media and content types, categories, repository type, and timestamps.

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', a bare official image name, or a Docker Hub URL (examples: "library/nginx", "nginx", "grafana/grafana", "https://hub.docker.com/r/grafana/grafana"; minLength: 1)

Response

• @type string (default: "DockerhubRepository")
• name string required
• namespace string required
• alias string required
• repository_type string nullable
• status_description string (default: "")
• description string nullable
• full_description string nullable
• is_private boolean (default: false)
• is_automated boolean (default: false)
• star_count integer (default: 0)
• pull_count integer (default: 0)
• storage_size integer (default: 0)
• affiliation string nullable
• media_types array (default: [])
• content_types array (default: [])
• categories array (default: [])
  • @type string (default: "DockerhubRepoCategory")
  • name string required
  • alias string required
• last_updated string nullable
• last_modified string nullable
• date_registered string nullable

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 not found 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.