Docs
View as Markdown

dockerhub.tag

stable Standard

Details of one Docker Hub image tag.

GET /v1/dockerhub/tag

What you get#

One Docker Hub record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

  • Standard · 1 credit for a fresh fetch, charged only when it succeeds.
  • Free when served from cache (0.2 credit for a cached response over 100 KB).
  • Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

NameTypeRequiredDefaultWhat it isConstraints
namespacestringyes(required)Docker Hub namespace (use library for official images)max 255 chars; must match [a-z0-9][a-z0-9_-]{1,254}; trimmed, lowercased
repostringyes(required)Docker Hub repositorymax 255 chars; must match [a-z0-9][a-z0-9_.-]{0,254}; trimmed, lowercased
tagstringyes(required)Image tagmax 128 chars; must match [A-Za-z0-9_][A-Za-z0-9_.-]{0,127}; trimmed

Request#

curl "https://api.onekey.dev/v1/dockerhub/tag?namespace=library&repo=nginx&tag=latest" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Docker Hub response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": {
    "entity": {
      "name": "latest",
      "updatedAt": "2026-09-19T04:53:15Z",
      "status": "active"
    },
    "ext": {
      "size": 63400795,
      "digest": "sha256:abe47724e466aeab9a345d8e46a221c2fa8953c7848bb4a3bd9976a7199f8cf2"
    },
    "author": {
      "username": "doijanky"
    }
  },
  "metadata": {
    "platform": "dockerhub",
    "endpoint": "tag",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source pathOnekey fieldTransform
nameentity.name-
last_updatedentity.updatedAttoIsoDate
full_sizeext.sizetoNumber
digestext.digest-
tag_statusentity.status-
last_updater_usernameauthor.username-

Caching and freshness#

  • Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
  • Between 1 hour and 1 day the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
  • If the source is down when a refresh is needed, the last copy can be served for up to 3 days more (marked stale).
  • A "not found" is remembered for 5 minutes and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundThat record does not exist. Free; do not retry.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).