Image

Inspect an image

Return low-level information about an image.

get/images/{name}/json

Request

Base URL
/v1.52 (relative, and the document was published on a file host, not at the API’s origin)
Auth
none declared
TypeScript
https://skmtc.dev/docker/apis/docker-engine-api/docs/images/:name/json/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

namestring required

Image name or id

Query parameters

manifestsboolean

Include Manifests in the image summary.

Response

No error

Idstring

ID is the content-addressable ID of an image.

This identifier is a content-addressable digest calculated from the image's configuration (which includes the digests of layers used by the image).

Note that this digest differs from the RepoDigests below, which holds digests of image manifests that reference the image.

RepoTagsstring[]

List of image names/tags in the local image cache that reference this image.

Multiple image tags can refer to the same image, and this list may be empty if no tags reference the image, in which case the image is "untagged", in which case it can still be referenced by its ID.

RepoDigestsstring[]

List of content-addressable digests of locally available image manifests that the image is referenced from. Multiple manifests can refer to the same image.

These digests are usually only available if the image was either pulled from a registry, or if the image was pushed to a registry, which is when the manifest is generated and its digest calculated.

Parentstring

ID of the parent image.

Depending on how the image was created, this field may be empty and is only set for images that were built/created locally. This field is empty if the image was pulled from an image registry.

Commentstring

Optional message that was set when committing or importing the image.

Createdstring dateTime nullable

Date and time at which the image was created, formatted in RFC 3339 format with nano-seconds.

This information is only available if present in the image, and omitted otherwise.

DockerVersionstring

The version of Docker that was used to build the image.

Depending on how the image was created, this field may be empty.

Authorstring

Name of the author that was specified when committing the image, or as specified through MAINTAINER (deprecated) in the Dockerfile.

Architecturestring

Hardware CPU architecture that the image runs on.

Variantstring nullable

CPU architecture variant (presently ARM-only).

Osstring

Operating System the image is built to run on.

OsVersionstring nullable

Operating System version the image is built to run on (especially for Windows).

Sizeinteger

Total size of the image including all layers it is composed of.

VirtualSizeinteger

Total size of the image including all layers it is composed of.

Deprecated: this field is omitted in API v1.44, but kept for backward compatibility. Use Size instead.

Example response

{
  "Id": "sha256:ec3f0931a6e6b6855d76b2d7b0be30e81860baccd891b2e243280bf1cd8ad710",
  "Descriptor": {
    "mediaType": "application/vnd.oci.image.manifest.v1+json",
    "digest": "sha256:c0537ff6a5218ef531ece93d4984efc99bbf3f7497c0a7726c88e2bb7584dc96",
    "size": 424,
    "annotations": {
      "com.docker.official-images.bashbrew.arch": "amd64",
      "org.opencontainers.image.base.digest": "sha256:0d0ef5c914d3ea700147da1bd050c59edb8bb12ca312f3800b29d7c8087eabd8",
      "org.opencontainers.image.base.name": "scratch",
      "org.opencontainers.image.created": "2025-01-27T00:00:00Z",
      "org.opencontainers.image.revision": "9fabb4bad5138435b01857e2fe9363e2dc5f6a79",
      "org.opencontainers.image.source": "https://git.launchpad.net/cloud-images/+oci/ubuntu-base",
      "org.opencontainers.image.url": "https://hub.docker.com/_/ubuntu",
      "org.opencontainers.image.version": "24.04"
    },
    "platform": {
      "architecture": "arm",
      "os": "windows",
      "os.version": "10.0.19041.1165",
      "os.features": [
        "win32k"
      ],
      "variant": "v7"
    }
  },
  "Manifests": [
    {
      "ID": "sha256:95869fbcf224d947ace8d61d0e931d49e31bb7fc67fffbbe9c3198c33aa8e93f",
      "Descriptor": {
        "mediaType": "application/vnd.oci.image.manifest.v1+json",
        "digest": "sha256:c0537ff6a5218ef531ece93d4984efc99bbf3f7497c0a7726c88e2bb7584dc96",
        "size": 424,
        "annotations": {
          "com.docker.official-images.bashbrew.arch": "amd64",
          "org.opencontainers.image.base.digest": "sha256:0d0ef5c914d3ea700147da1bd050c59edb8bb12ca312f3800b29d7c8087eabd8",
          "org.opencontainers.image.base.name": "scratch",
          "org.opencontainers.image.created": "2025-01-27T00:00:00Z",
          "org.opencontainers.image.revision": "9fabb4bad5138435b01857e2fe9363e2dc5f6a79",
          "org.opencontainers.image.source": "https://git.launchpad.net/cloud-images/+oci/ubuntu-base",
          "org.opencontainers.image.url": "https://hub.docker.com/_/ubuntu",
          "org.opencontainers.image.version": "24.04"
        },
        "platform": {
          "architecture": "arm",
          "os": "windows",
          "os.version": "10.0.19041.1165",
          "os.features": [
            "win32k"
          ],
          "variant": "v7"
        }
      },
      "Available": true,
      "Size": {
        "Total": 8213251,
        "Content": 3987495
      },
      "Kind": "image",
      "ImageData": {
        "Platform": {
          "architecture": "arm",
          "os": "windows",
          "os.version": "10.0.19041.1165",
          "os.features": [
            "win32k"
          ],
          "variant": "v7"
        },
        "Containers": [
          "ede54ee1fda366ab42f824e8a5ffd195155d853ceaec74a927f249ea270c7430",
          "abadbce344c096744d8d6071a90d474d28af8f1034b5ea9fb03c3f4bfc6d005e"
        ],
        "Size": {
          "Unpacked": 3987495
        }
      },
      "AttestationData": {
        "For": "sha256:95869fbcf224d947ace8d61d0e931d49e31bb7fc67fffbbe9c3198c33aa8e93f"
      }
    }
  ],
  "RepoTags": [
    "example:1.0",
    "example:latest",
    "example:stable",
    "internal.registry.example.com:5000/example:1.0"
  ],
  "RepoDigests": [
    "example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb",
    "internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578"
  ],
  "Created": "2022-02-04T21:20:12.497794809Z",
  "DockerVersion": "27.0.1",
  "Config": {
    "User": "web:web",
    "ExposedPorts": {
      "80/tcp": {},
      "443/tcp": {}
    },
    "Env": [
      "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
    ],
    "Cmd": [
      "/bin/sh"
    ],
    "Volumes": {
      "/app/data": {},
      "/app/config": {}
    },
    "WorkingDir": "/public/",
    "Entrypoint": [],
    "OnBuild": [],
    "Labels": {
      "com.example.some-label": "some-value",
      "com.example.some-other-label": "some-other-value"
    },
    "StopSignal": "SIGTERM",
    "Shell": [
      "/bin/sh",
      "-c"
    ]
  },
  "Architecture": "arm",
  "Variant": "v7",
  "Os": "linux",
  "Size": 1239828,
  "VirtualSize": 1239828,
  "GraphDriver": {
    "Name": "overlay2",
    "Data": {
      "MergedDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/merged",
      "UpperDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/diff",
      "WorkDir": "/var/lib/docker/overlay2/ef749362d13333e65fc95c572eb525abbe0052e16e086cb64bc3b98ae9aa6d74/work"
    }
  },
  "RootFS": {
    "Type": "layers",
    "Layers": [
      "sha256:1834950e52ce4d5a88a1bbd131c537f4d0e56d10ff0dd69e66be3b7dfa9df7e6",
      "sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef"
    ]
  },
  "Metadata": {
    "LastTagTime": "2022-02-28T14:40:02.623929178Z"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.