---
title: "List Images"
method: GET
path: "/images/json"
tags: ["Image"]
---

# List Images

`GET /images/json`

Returns a list of images on the server. Note that it uses a different, smaller representation of an image than inspecting a single image.

## Query parameters

- `all` boolean
- `filters` string
- `shared-size` boolean
- `digests` boolean
- `manifests` boolean
- `identity` boolean

## Response `200`

Summary image data for the images matching the query

- 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, 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.
  - `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.

## Other responses

- `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/revisions/4752769870da/schema)
