--- title: "GET /images/json" method: GET path: "/images/json" --- # GET /images/json `GET /images/json` List Images ## Query parameters - `all` boolean - `filters` string - `shared-size` boolean - `digests` boolean - `manifests` boolean ## Response `200` The request has succeeded. - ImageSummary[] - `Id` string, required — 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. - `ParentId` string, required — 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. - `RepoTags` string[], required — 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[], required — 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. - `Created` integer, required — Date and time at which the image was created as a Unix timestamp (number of seconds since EPOCH). - `Size` integer, required — Total size of the image including all layers it is composed of. - `SharedSize` integer, required — Total size of image layers that are shared between this image and other images. This size is not calculated by default. `-1` indicates that the value has not been set / calculated. - `Labels` object, required — User-defined key/value metadata. - `Containers` integer, required — Number of containers using this image. Includes both stopped and running containers. `-1` indicates that the value has not been set / calculated. - `Manifests` ImageManifestSummary[] — Manifests is a list of 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. 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 — 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 - `Content` integer, required - `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, 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`. - `Containers` string[], required - `Size` object, required - `Unpacked` integer, required - `AttestationData` object, nullable — The image data for the attestation manifest. This field is only populated when Kind is "attestation". - `For` string, required - `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 — 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. --- [API](https://skmtc.net/hexlet/apis/docker-engine-api.md) · [All operations](https://skmtc.net/hexlet/apis/docker-engine-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hexlet/docker-engine-api/versions/7dbd508c79cf/schema)