HEhexlet
Image

List Images

Changed on

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

get/images/json

Request

  • Base URL
    /v1.57 (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    none declared

Query parameters

allboolean

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

filtersstring

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-sizeboolean

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

digestsboolean

Show digest information as a RepoDigests field on each image.

manifestsboolean

Include Manifests in the image summary.

identityboolean

Include Identity in each manifest summary. Requires manifests=1.

Response

Summary image data for the images matching the query

Idstring 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.

ParentIdstring 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.

RepoTagsstring[] 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.

RepoDigestsstring[] 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.

Createdinteger required

Date and time at which the image was created as a Unix timestamp (number of seconds since EPOCH).

Sizeinteger required

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

SharedSizeinteger 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.

Labelsobject required

User-defined key/value metadata.

Containersinteger required

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

-1 indicates that the value has not been set / calculated.

Changes

  • f86e64e24331Revision changes
    • info

      added the new optional query request parameter identity

  • 6df97b60796cRevision changes
    • breaking

      removed the media type application/json for the response with the status

    • info

      api tag Image added

    • info

      added the non-success response with the status