List Images Run in API Explorer

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

    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.

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 sinds 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.
  • 500 application/json

    server error

    Hide response attribute Show response attribute object
    • message string Required

      The error message.
GET /images/json 
curl \
 --request GET 'http://api.example.com/v1.44/images/json'
Response examples (200) 
[
  {
    "Id": "sha256:ec3f0931a6e6b6855d76b2d7b0be30e81860baccd891b2e243280bf1cd8ad710",
    "ParentId": "string",
    "RepoTags": [
      "example:1.0",
      "example:latest",
      "example:stable",
      "internal.registry.example.com:5000/example:1.0"
    ],
    "RepoDigests": [
      "example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb",
      "internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578"
    ],
    "Created": "1644009612",
    "Size": 172064416,
    "SharedSize": 1239828,
    "VirtualSize": 172064416,
    "Labels": {
      "com.example.some-label": "some-value",
      "com.example.some-other-label": "some-other-value"
    },
    "Containers": 2
  }
]
Response examples (500) 
{
  "message": "Something went wrong."
}
Response examples (500) 
{
  "message": "Something went wrong."
}