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

      A descriptor struct containing digest, media type, and size, as defined in the OCI Content Descriptors Specification.

      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.

    • 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.44/distribution/{name}/json'
Response examples (200) 
{
  "Descriptor": {
    "mediaType": "application/vnd.docker.distribution.manifest.v2+json",
    "digest": "sha256:c0537ff6a5218ef531ece93d4984efc99bbf3f7497c0a7726c88e2bb7584dc96",
    "size": 3987495
  },
  "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."
}