Query parameters

• all boolean

  Show all images. Only images from a final layer (no children) are shown by default.

  Default value is false.

• filters string

  A JSON encoded value of the filters (a map[string][]string) to process on the images list.

  Available filters:

  • before=(<image-name>[:<tag>], <image id> or <image@digest>)
  • dangling=true
  • label=key or label="key=value" of an image label
  • reference=(<image-name>[:<tag>])
  • since=(<image-name>[:<tag>], <image id> or <image@digest>)
  • until=<timestamp>
• shared-size boolean

  Compute and show shared size as a SharedSize field on each image.

  Default value is false.

• digests boolean

  Show digest information as a RepoDigests field on each image.

  Default value is false.

• manifests boolean

  Include Manifests in the image summary.

  Default value is false.

Responses

• 200 application/json

  Summary image data for the images matching the query

  Hide response attributes Show response attributes object

  • 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 array[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 array[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(int64) Required

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

  • SharedSize integer(int64) 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.

  • VirtualSize integer(int64)

    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.

  • Labels object Required

    User-defined key/value metadata.

    Hide Labels attribute Show Labels attribute object

    • * string Additional properties
  • Containers integer Required

    Number of containers using this image. Includes both stopped and running containers.

    This size is not calculated by default, and depends on which API endpoint is used. -1 indicates that the value has not been set / calculated.

  • Manifests array[object]

    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.

    ImageManifestSummary represents a summary of an image manifest.

    Hide Manifests attributes Show Manifests attributes object

    • ID string Required

      ID is the content-addressable ID of an image and is the same as the digest of the image manifest.

    • Descriptor object Required

      Descriptor is an OCI descriptor of the image target. In case of a multi-platform image, this descriptor points to the OCI index or a manifest list.

      This field is only present if the daemon provides a multi-platform image store.

      WARNING: This is experimental and may change at any time without any backward compatibility.

      Hide Descriptor attributes Show Descriptor attributes object

      • mediaType string

        The media type of the object this schema refers to.

      • digest string

        The digest of the targeted content.

      • size integer(int64)

        The size in bytes of the blob.

      • urls array[string(uri)]

        List of URLs from which this object MAY be downloaded.

      • annotations object

        Arbitrary metadata relating to the targeted content.

        Hide annotations attribute Show annotations attribute object

        • * string Additional properties
      • data string

        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 object

        Describes the platform which the image in the manifest runs on, as defined in the OCI Image Index Specification.

        Hide platform attributes Show platform attributes object

        • 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 array[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

        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
      Hide Size attributes Show Size attributes object

      • Total integer(int64) 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(int64) 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 string 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.

      Values are image, attestation, or unknown.

    • ImageData object

      The image data for the image manifest. This field is only populated when Kind is "image".

      Hide ImageData attributes Show ImageData attributes object

      • Platform object Required

        Describes the platform which the image in the manifest runs on, as defined in the OCI Image Index Specification.

        Hide Platform attributes Show Platform attributes object

        • 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 array[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 array[string] Required

        The IDs of the containers that are using this image.

      • Size object Required
        Hide Size attribute Show Size attribute object

        • Unpacked integer(int64) 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

      The image data for the attestation manifest. This field is only populated when Kind is "attestation".

      Hide AttestationData attribute Show AttestationData attribute object

      • For string Required

        The digest of the image manifest that this attestation is for.

  • Descriptor object

    Descriptor is an OCI descriptor of the image target. In case of a multi-platform image, this descriptor points to the OCI index or a manifest list.

    This field is only present if the daemon provides a multi-platform image store.

    WARNING: This is experimental and may change at any time without any backward compatibility.

    Hide Descriptor attributes Show Descriptor attributes object

    • mediaType string

      The media type of the object this schema refers to.

    • digest string

      The digest of the targeted content.

    • size integer(int64)

      The size in bytes of the blob.

    • urls array[string(uri)]

      List of URLs from which this object MAY be downloaded.

    • annotations object

      Arbitrary metadata relating to the targeted content.

      Hide annotations attribute Show annotations attribute object

      • * string Additional properties
    • data string

      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 object

      Describes the platform which the image in the manifest runs on, as defined in the OCI Image Index Specification.

      Hide platform attributes Show platform attributes object

      • 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 array[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

      ArtifactType is the IANA media type of this artifact.

• 500 application/json

  server error

  Hide response attribute Show response attribute object

  • message string Required

    The error message.