Get image information from the registry Run in API Explorer

GET /distribution/{name}/json

Return image digest and platform information by contacting the registry.

Path parameters

  • name string Required

    Image name or id

Responses

  • 200 application/json

    descriptor and platform information

    Hide response attributes Show response attributes object
    • Descriptor object Required

      Descriptor is an OCI descriptor of the image target. In case of a multi-platform image, this descriptor points to the OCI index or a manifest list.

      This field is only present if the daemon provides a multi-platform image store.

      WARNING: This is experimental and may change at any time without any backward compatibility.

      Hide Descriptor attributes Show Descriptor attributes object
      • mediaType string

        The media type of the object this schema refers to.

      • digest string

        The digest of the targeted content.

      • size integer(int64)

        The size in bytes of the blob.

      • urls array[string(uri)]

        List of URLs from which this object MAY be downloaded.

      • annotations object

        Arbitrary metadata relating to the targeted content.

        Hide annotations attribute Show annotations attribute object
        • * string Additional properties
      • data string

        Data is an embedding of the targeted content. This is encoded as a base64 string when marshalled to JSON (automatically, by encoding/json). If present, Data can be used directly to avoid fetching the targeted content.

      • platform object

        Describes the platform which the image in the manifest runs on, as defined in the OCI Image Index Specification.

        Hide platform attributes Show platform attributes object
        • architecture string

          The CPU architecture, for example amd64 or ppc64.

        • os string

          The operating system, for example linux or windows.

        • os.version string

          Optional field specifying the operating system version, for example on Windows 10.0.19041.1165.

        • os.features array[string]

          Optional field specifying an array of strings, each listing a required OS feature (for example on Windows win32k).

        • variant string

          Optional field specifying a variant of the CPU, for example v7 to specify ARMv7 when architecture is arm.

      • artifactType string

        ArtifactType is the IANA media type of this artifact.

    • Platforms array[object] Required

      An array containing all platforms supported by the image.

      Describes the platform which the image in the manifest runs on, as defined in the OCI Image Index Specification.

      Hide Platforms attributes Show Platforms attributes object
      • architecture string

        The CPU architecture, for example amd64 or ppc64.

      • os string

        The operating system, for example linux or windows.

      • os.version string

        Optional field specifying the operating system version, for example on Windows 10.0.19041.1165.

      • os.features array[string]

        Optional field specifying an array of strings, each listing a required OS feature (for example on Windows win32k).

      • variant string

        Optional field specifying a variant of the CPU, for example v7 to specify ARMv7 when architecture is arm.
  • 401 application/json

    Failed authentication or no image found

    Hide response attribute Show response attribute object
    • message string Required

      The error message.
  • 500 application/json

    Server error

    Hide response attribute Show response attribute object
    • message string Required

      The error message.
GET /distribution/{name}/json 
curl \
 --request GET 'http://api.example.com/v1.49/distribution/{name}/json'
Response examples (200) 
{
  "Descriptor": {
    "mediaType": "application/vnd.oci.image.manifest.v1+json",
    "digest": "sha256:c0537ff6a5218ef531ece93d4984efc99bbf3f7497c0a7726c88e2bb7584dc96",
    "size": 424,
    "urls": [
      "https://example.com"
    ],
    "annotations": {
      "org.opencontainers.image.url": "https://hub.docker.com/_/ubuntu",
      "org.opencontainers.image.source": "https://git.launchpad.net/cloud-images/+oci/ubuntu-base",
      "org.opencontainers.image.created": "2025-01-27T00:00:00Z",
      "org.opencontainers.image.version": "24.04",
      "org.opencontainers.image.revision": "9fabb4bad5138435b01857e2fe9363e2dc5f6a79",
      "org.opencontainers.image.base.name": "scratch",
      "org.opencontainers.image.base.digest": "sha256:0d0ef5c914d3ea700147da1bd050c59edb8bb12ca312f3800b29d7c8087eabd8",
      "com.docker.official-images.bashbrew.arch": "amd64"
    },
    "data": "string",
    "platform": {
      "architecture": "arm",
      "os": "windows",
      "os.version": "10.0.19041.1165",
      "os.features": [
        "win32k"
      ],
      "variant": "v7"
    },
    "artifactType": "string"
  },
  "Platforms": [
    {
      "architecture": "arm",
      "os": "windows",
      "os.version": "10.0.19041.1165",
      "os.features": [
        "win32k"
      ],
      "variant": "v7"
    }
  ]
}
Response examples (401) 
{
  "message": "No such image: someimage (tag: latest)"
}
Response examples (401) 
{
  "message": "Something went wrong."
}
Response examples (500) 
{
  "message": "Something went wrong."
}
Response examples (500) 
{
  "message": "Something went wrong."
}