---
title: "Inspect an image"
method: GET
path: "/images/{name}/json"
tags: ["Image"]
---

# Inspect an image

`GET /images/{name}/json`

Return low-level information about an image.

## Path parameters

- `name` string, required

## Response `200`

No error

- ImageInspect — Information about an image in the local image cache.
  - `Id` string — 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.
  - `RepoTags` string[] — 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.
  - `RepoDigests` string[] — 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.
  - `Parent` string — 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.
  - `Comment` string — Optional message that was set when committing or importing the image.
  - `Created` string — Date and time at which the image was created, formatted in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
  - `Container` string — The ID of the container that was used to create the image. Depending on how the image was created, this field may be empty.
  - `ContainerConfig` ContainerConfig — Configuration for a container that is portable between hosts. When used as `ContainerConfig` field in an image, `ContainerConfig` is an optional field containing the configuration of the container that was last committed when creating the image. Previous versions of Docker builder used this field to store build cache, and it is not in active use anymore.
    - `Hostname` string — The hostname to use for the container, as a valid RFC 1123 hostname.
    - `Domainname` string — The domain name to use for the container.
    - `User` string — The user that commands are run as inside the container.
    - `AttachStdin` boolean — Whether to attach to `stdin`.
    - `AttachStdout` boolean — Whether to attach to `stdout`.
    - `AttachStderr` boolean — Whether to attach to `stderr`.
    - `ExposedPorts` object, nullable — An object mapping ports to an empty object in the form: `{"<port>/<tcp|udp|sctp>": {}}`
    - `Tty` boolean — Attach standard streams to a TTY, including `stdin` if it is not closed.
    - `OpenStdin` boolean — Open `stdin`
    - `StdinOnce` boolean — Close `stdin` after one attached client disconnects
    - `Env` string[] — A list of environment variables to set inside the container in the form `["VAR=value", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value.
    - `Cmd` string[] — Command to run specified as a string or an array of strings.
    - `Healthcheck` HealthConfig — A test to perform to check that the container is healthy.
      - `Test` string[] — The test to perform. Possible values are: - `[]` inherit healthcheck from image or parent image - `["NONE"]` disable healthcheck - `["CMD", args...]` exec arguments directly - `["CMD-SHELL", command]` run command with system's default shell
      - `Interval` integer — The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
      - `Timeout` integer — The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
      - `Retries` integer — The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit.
      - `StartPeriod` integer — Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
    - `ArgsEscaped` boolean, nullable — Command is already escaped (Windows only)
    - `Image` string — The name (or reference) of the image to use when creating the container, or which was used when the container was created.
    - `Volumes` object — An object mapping mount point paths inside the container to empty objects.
    - `WorkingDir` string — The working directory for commands to run in.
    - `Entrypoint` string[] — The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[""]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`).
    - `NetworkDisabled` boolean, nullable — Disable networking for the container.
    - `MacAddress` string, nullable — MAC address of the container.
    - `OnBuild` string[], nullable — `ONBUILD` metadata that were defined in the image's `Dockerfile`.
    - `Labels` object — User-defined key/value metadata.
    - `StopSignal` string, nullable — Signal to stop a container as a string or unsigned integer.
    - `StopTimeout` integer, nullable — Timeout to stop a container in seconds.
    - `Shell` string[], nullable — Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.
  - `DockerVersion` string — The version of Docker that was used to build the image. Depending on how the image was created, this field may be empty.
  - `Author` string — Name of the author that was specified when committing the image, or as specified through MAINTAINER (deprecated) in the Dockerfile.
  - `Config` ContainerConfig — Configuration for a container that is portable between hosts. When used as `ContainerConfig` field in an image, `ContainerConfig` is an optional field containing the configuration of the container that was last committed when creating the image. Previous versions of Docker builder used this field to store build cache, and it is not in active use anymore.
    - `Hostname` string — The hostname to use for the container, as a valid RFC 1123 hostname.
    - `Domainname` string — The domain name to use for the container.
    - `User` string — The user that commands are run as inside the container.
    - `AttachStdin` boolean — Whether to attach to `stdin`.
    - `AttachStdout` boolean — Whether to attach to `stdout`.
    - `AttachStderr` boolean — Whether to attach to `stderr`.
    - `ExposedPorts` object, nullable — An object mapping ports to an empty object in the form: `{"<port>/<tcp|udp|sctp>": {}}`
    - `Tty` boolean — Attach standard streams to a TTY, including `stdin` if it is not closed.
    - `OpenStdin` boolean — Open `stdin`
    - `StdinOnce` boolean — Close `stdin` after one attached client disconnects
    - `Env` string[] — A list of environment variables to set inside the container in the form `["VAR=value", ...]`. A variable without `=` is removed from the environment, rather than to have an empty value.
    - `Cmd` string[] — Command to run specified as a string or an array of strings.
    - `Healthcheck` HealthConfig — A test to perform to check that the container is healthy.
      - `Test` string[] — The test to perform. Possible values are: - `[]` inherit healthcheck from image or parent image - `["NONE"]` disable healthcheck - `["CMD", args...]` exec arguments directly - `["CMD-SHELL", command]` run command with system's default shell
      - `Interval` integer — The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
      - `Timeout` integer — The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
      - `Retries` integer — The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit.
      - `StartPeriod` integer — Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
    - `ArgsEscaped` boolean, nullable — Command is already escaped (Windows only)
    - `Image` string — The name (or reference) of the image to use when creating the container, or which was used when the container was created.
    - `Volumes` object — An object mapping mount point paths inside the container to empty objects.
    - `WorkingDir` string — The working directory for commands to run in.
    - `Entrypoint` string[] — The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string (`[""]`) then the entry point is reset to system default (i.e., the entry point used by docker when there is no `ENTRYPOINT` instruction in the `Dockerfile`).
    - `NetworkDisabled` boolean, nullable — Disable networking for the container.
    - `MacAddress` string, nullable — MAC address of the container.
    - `OnBuild` string[], nullable — `ONBUILD` metadata that were defined in the image's `Dockerfile`.
    - `Labels` object — User-defined key/value metadata.
    - `StopSignal` string, nullable — Signal to stop a container as a string or unsigned integer.
    - `StopTimeout` integer, nullable — Timeout to stop a container in seconds.
    - `Shell` string[], nullable — Shell for when `RUN`, `CMD`, and `ENTRYPOINT` uses a shell.
  - `Architecture` string — Hardware CPU architecture that the image runs on.
  - `Variant` string, nullable — CPU architecture variant (presently ARM-only).
  - `Os` string — Operating System the image is built to run on.
  - `OsVersion` string, nullable — Operating System version the image is built to run on (especially for Windows).
  - `Size` integer — Total size of the image including all layers it is composed of.
  - `VirtualSize` integer — Total size of the image including all layers it is composed of. In versions of Docker before v1.10, this field was calculated from the image itself and all of its parent images. Images are now stored self-contained, and no longer use a parent-chain, making this field an equivalent of the Size field. > **Deprecated**: this field is kept for backward compatibility, but > will be removed in API v1.44.
  - `GraphDriver` GraphDriverData — Information about the storage driver used to store the container's and image's filesystem.
    - `Name` string, required — Name of the storage driver.
    - `Data` object, required — Low-level storage metadata, provided as key/value pairs. This information is driver-specific, and depends on the storage-driver in use, and should be used for informational purposes only.
  - `RootFS` object — Information about the image's RootFS, including the layer IDs.
    - `Type` string, required
    - `Layers` string[]
  - `Metadata` object — Additional metadata of the image in the local cache. This information is local to the daemon, and not part of the image itself.
    - `LastTagTime` string, dateTime, nullable — Date and time at which the image was last tagged in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. This information is only available if the image was tagged locally, and omitted otherwise.

## Other responses

- `404` — No such image
- `500` — Server error

---

[API](https://skmtc.net/aliyun/apis/docker-engine-api.md) · [All operations](https://skmtc.net/aliyun/apis/docker-engine-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aliyun/docker-engine-api/versions/04bb09da9ccb/schema)