--- 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 ## Query parameters - `manifests` boolean - `platform` string ## 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. - `Descriptor` OCIDescriptor — A descriptor struct containing digest, media type, and size, as defined in the [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md). - `mediaType` string — The media type of the object this schema refers to. - `digest` string — The digest of the targeted content. - `size` integer — The size in bytes of the blob. - `urls` string[], nullable — List of URLs from which this object MAY be downloaded. - `annotations` object, nullable — Arbitrary metadata relating to the targeted content. - `data` string, nullable — 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` OCIPlatform, nullable — Describes the platform which the image in the manifest runs on, as defined in the [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md). - `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` 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, nullable — ArtifactType is the IANA media type of this artifact. - `Manifests` ImageManifestSummary[], nullable — Manifests is a list of image manifests available in this image. It provides a more detailed view of the platform-specific image manifests or other image-attached data like build attestations. Only available if the daemon provides a multi-platform image store and the `manifests` option is set in the inspect request. WARNING: This is experimental and may change at any time without any backward compatibility. - `ID` string, required — ID is the content-addressable ID of an image and is the same as the digest of the image manifest. - `Descriptor` OCIDescriptor, required — A descriptor struct containing digest, media type, and size, as defined in the [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md). - `mediaType` string — The media type of the object this schema refers to. - `digest` string — The digest of the targeted content. - `size` integer — The size in bytes of the blob. - `urls` string[], nullable — List of URLs from which this object MAY be downloaded. - `annotations` object, nullable — Arbitrary metadata relating to the targeted content. - `data` string, nullable — 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` OCIPlatform, nullable — Describes the platform which the image in the manifest runs on, as defined in the [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md). - `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` 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, nullable — ArtifactType is the IANA media type of this artifact. - `Available` boolean, required — Indicates whether all the child content (image config, layers) is fully available locally. - `Size` object, required - `Total` integer, required — Total is the total size (in bytes) of all the locally present data (both distributable and non-distributable) that's related to this manifest and its children. This equal to the sum of [Content] size AND all the sizes in the [Size] struct present in the Kind-specific data struct. For example, for an image kind (Kind == "image") this would include the size of the image content and unpacked image snapshots ([Size.Content] + [ImageData.Size.Unpacked]). - `Content` integer, required — Content is the size (in bytes) of all the locally present content in the content store (e.g. image config, layers) referenced by this manifest and its children. This only includes blobs in the content store. - `Kind` 'image' | 'attestation' | 'unknown', required — The kind of the manifest. kind | description -------------|----------------------------------------------------------- image | Image manifest that can be used to start a container. attestation | Attestation manifest produced by the Buildkit builder for a specific image manifest. - `ImageData` object, nullable — The image data for the image manifest. This field is only populated when Kind is "image". - `Platform` OCIPlatform, nullable, required — Describes the platform which the image in the manifest runs on, as defined in the [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md). - `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` 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`. - `Identity` Identity — Identity holds information about the identity and origin of the image. This is trusted information verified by the daemon and cannot be modified by tagging an image to a different name. - `Signature` SignatureIdentity[] — Signature contains the properties of verified signatures for the image. - `Name` string — Name is a textual description summarizing the type of signature. - `Timestamps` SignatureTimestamp[] — Timestamps contains a list of verified signed timestamps for the signature. - `Type` 'Tlog' | 'TimestampAuthority' — SignatureTimestampType is the type of timestamp used in the signature. - `URI` string - `Timestamp` string, date-time - `KnownSigner` 'DHI' — KnownSignerIdentity is an identifier for a special signer identity that is known to the implementation. - `DockerReference` string — DockerReference is the Docker image reference associated with the signature. This is an optional field only present in older hashedrecord signatures. - `Signer` SignerIdentity — SignerIdentity contains information about the signer certificate used to sign the image. - `CertificateIssuer` string — CertificateIssuer is the certificate issuer. - `SubjectAlternativeName` string — SubjectAlternativeName is the certificate subject alternative name. - `Issuer` string — The OIDC issuer. Should match `iss` claim of ID token or, in the case of a federated login like Dex it should match the issuer URL of the upstream issuer. The issuer is not set the extensions are invalid and will fail to render. - `BuildSignerURI` string — Reference to specific build instructions that are responsible for signing. - `BuildSignerDigest` string — Immutable reference to the specific version of the build instructions that is responsible for signing. - `RunnerEnvironment` string — Specifies whether the build took place in platform-hosted cloud infrastructure or customer/self-hosted infrastructure. - `SourceRepositoryURI` string — Source repository URL that the build was based on. - `SourceRepositoryDigest` string — Immutable reference to a specific version of the source code that the build was based upon. - `SourceRepositoryRef` string — Source Repository Ref that the build run was based upon. - `SourceRepositoryIdentifier` string — Immutable identifier for the source repository the workflow was based upon. - `SourceRepositoryOwnerURI` string — Source repository owner URL of the owner of the source repository that the build was based on. - `SourceRepositoryOwnerIdentifier` string — Immutable identifier for the owner of the source repository that the workflow was based upon. - `BuildConfigURI` string — Build Config URL to the top-level/initiating build instructions. - `BuildConfigDigest` string — Immutable reference to the specific version of the top-level/initiating build instructions. - `BuildTrigger` string — Event or action that initiated the build. - `RunInvocationURI` string — Run Invocation URL to uniquely identify the build execution. - `SourceRepositoryVisibilityAtSigning` string — Source repository visibility at the time of signing the certificate. - `SignatureType` 'bundle-v0.3' | 'simplesigning-v1' — SignatureType is the type of signature format. - `Error` string — Error contains error information if signature verification failed. Other fields will be empty in this case. - `Warnings` string[] — Warnings contains any warnings that occurred during signature verification. For example, if there was no internet connectivity and cached trust roots were used. Warning does not indicate a failed verification but may point to configuration issues. - `Pull` PullIdentity[] — Pull contains remote location information if image was created via pull. If image was pulled via mirror, this contains the original repository location. After successful push this images also contains the pushed repository location. - `Repository` string — Repository is the remote repository location the image was pulled from. - `Build` BuildIdentity[] — Build contains build reference information if image was created via build. - `Ref` string — Ref is the identifier for the build request. This reference can be used to look up the build details in BuildKit history API. - `CreatedAt` string, date-time — CreatedAt is the time when the build ran. - `Containers` string[], required — The IDs of the containers that are using this image. - `Size` object, required - `Unpacked` integer, required — Unpacked is the size (in bytes) of the locally unpacked (uncompressed) image content that's directly usable by the containers running this image. It's independent of the distributable content - e.g. the image might still have an unpacked data that's still used by some container even when the distributable/compressed content is already gone. - `AttestationData` object, nullable — The image data for the attestation manifest. This field is only populated when Kind is "attestation". - `For` string, required — The digest of the image manifest that this attestation is for. - `Identity` Identity — Identity holds information about the identity and origin of the image. This is trusted information verified by the daemon and cannot be modified by tagging an image to a different name. - `Signature` SignatureIdentity[] — Signature contains the properties of verified signatures for the image. - `Name` string — Name is a textual description summarizing the type of signature. - `Timestamps` SignatureTimestamp[] — Timestamps contains a list of verified signed timestamps for the signature. - `Type` 'Tlog' | 'TimestampAuthority' — SignatureTimestampType is the type of timestamp used in the signature. - `URI` string - `Timestamp` string, date-time - `KnownSigner` 'DHI' — KnownSignerIdentity is an identifier for a special signer identity that is known to the implementation. - `DockerReference` string — DockerReference is the Docker image reference associated with the signature. This is an optional field only present in older hashedrecord signatures. - `Signer` SignerIdentity — SignerIdentity contains information about the signer certificate used to sign the image. - `CertificateIssuer` string — CertificateIssuer is the certificate issuer. - `SubjectAlternativeName` string — SubjectAlternativeName is the certificate subject alternative name. - `Issuer` string — The OIDC issuer. Should match `iss` claim of ID token or, in the case of a federated login like Dex it should match the issuer URL of the upstream issuer. The issuer is not set the extensions are invalid and will fail to render. - `BuildSignerURI` string — Reference to specific build instructions that are responsible for signing. - `BuildSignerDigest` string — Immutable reference to the specific version of the build instructions that is responsible for signing. - `RunnerEnvironment` string — Specifies whether the build took place in platform-hosted cloud infrastructure or customer/self-hosted infrastructure. - `SourceRepositoryURI` string — Source repository URL that the build was based on. - `SourceRepositoryDigest` string — Immutable reference to a specific version of the source code that the build was based upon. - `SourceRepositoryRef` string — Source Repository Ref that the build run was based upon. - `SourceRepositoryIdentifier` string — Immutable identifier for the source repository the workflow was based upon. - `SourceRepositoryOwnerURI` string — Source repository owner URL of the owner of the source repository that the build was based on. - `SourceRepositoryOwnerIdentifier` string — Immutable identifier for the owner of the source repository that the workflow was based upon. - `BuildConfigURI` string — Build Config URL to the top-level/initiating build instructions. - `BuildConfigDigest` string — Immutable reference to the specific version of the top-level/initiating build instructions. - `BuildTrigger` string — Event or action that initiated the build. - `RunInvocationURI` string — Run Invocation URL to uniquely identify the build execution. - `SourceRepositoryVisibilityAtSigning` string — Source repository visibility at the time of signing the certificate. - `SignatureType` 'bundle-v0.3' | 'simplesigning-v1' — SignatureType is the type of signature format. - `Error` string — Error contains error information if signature verification failed. Other fields will be empty in this case. - `Warnings` string[] — Warnings contains any warnings that occurred during signature verification. For example, if there was no internet connectivity and cached trust roots were used. Warning does not indicate a failed verification but may point to configuration issues. - `Pull` PullIdentity[] — Pull contains remote location information if image was created via pull. If image was pulled via mirror, this contains the original repository location. After successful push this images also contains the pushed repository location. - `Repository` string — Repository is the remote repository location the image was pulled from. - `Build` BuildIdentity[] — Build contains build reference information if image was created via build. - `Ref` string — Ref is the identifier for the build request. This reference can be used to look up the build details in BuildKit history API. - `CreatedAt` string, date-time — CreatedAt is the time when the build ran. - `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. - `Comment` string, nullable — Optional message that was set when committing or importing the image. - `Created` string, dateTime, nullable — Date and time at which the image was created, formatted in [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds. This information is only available if present in the image, and omitted otherwise. - `Author` string, nullable — Name of the author that was specified when committing the image, or as specified through MAINTAINER (deprecated) in the Dockerfile. - `Config` ImageConfig — Configuration of the image. These fields are used as defaults when starting a container from the image. - `User` string — The user that commands are run as inside the container. - `ExposedPorts` object, nullable — An object mapping ports to an empty object in the form: `{"/": {}}` - `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. Healthcheck commands should be side-effect free. - `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 A non-zero exit code indicates a failed healthcheck: - `0` healthy - `1` unhealthy - `2` reserved (treated as unhealthy) - other values: error running probe - `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. If the health check command does not complete within this timeout, the check is considered failed and the health check process is forcibly terminated without a graceful shutdown. - `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. - `StartInterval` integer — The time to wait between checks in nanoseconds during the start period. It should be 0 or at least 1000000 (1 ms). 0 means inherit. - `ArgsEscaped` boolean, nullable — Command is already escaped (Windows only) - `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`). - `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. - `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. - `GraphDriver` DriverData — 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/moby/apis/docker-engine-api.md) · [All operations](https://skmtc.net/moby/apis/docker-engine-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/moby/docker-engine-api/versions/4752769870da/schema)