Search or ask Docker

ImageSummary

ImageSummary schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

Containers · required

Type: integer

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

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

All schema constraints and annotations
{
  "description": "Number of containers using this image. Includes both stopped and running\ncontainers.\n\n`-1` indicates that the value has not been set / calculated.\n",
  "example": 2,
  "type": "integer",
  "x-nullable": false
}
Created · required

Type: integer

Date and time at which the image was created as a Unix timestamp (number of seconds since EPOCH).
All schema constraints and annotations
{
  "description": "Date and time at which the image was created as a Unix timestamp\n(number of seconds since EPOCH).\n",
  "example": "1644009612",
  "type": "integer",
  "x-nullable": false
}
Descriptor

Schema: OCIDescriptor

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.

All schema constraints and annotations
{
  "$ref": "#/components/schemas/OCIDescriptor",
  "description": "Descriptor is an OCI descriptor of the image target.\nIn case of a multi-platform image, this descriptor points to the OCI index\nor a manifest list.\n\nThis field is only present if the daemon provides a multi-platform image store.\n\nWARNING: This is experimental and may change at any time without any backward\ncompatibility.\n",
  "x-nullable": true
}
Id · required

Type: string

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.

All schema constraints and annotations
{
  "description": "ID is the content-addressable ID of an image.\n\nThis identifier is a content-addressable digest calculated from the\nimage's configuration (which includes the digests of layers used by\nthe image).\n\nNote that this digest differs from the `RepoDigests` below, which\nholds digests of image manifests that reference the image.\n",
  "example": "sha256:ec3f0931a6e6b6855d76b2d7b0be30e81860baccd891b2e243280bf1cd8ad710",
  "type": "string",
  "x-nullable": false
}
Labels · required

Type: object

User-defined key/value metadata.
All schema constraints and annotations
{
  "additionalProperties": {
    "type": "string"
  },
  "description": "User-defined key/value metadata.",
  "example": {
    "com.example.some-label": "some-value",
    "com.example.some-other-label": "some-other-value"
  },
  "type": "object",
  "x-nullable": false
}
Manifests

Type: array

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.

Array item

Schema: ImageManifestSummary

All schema constraints and annotations
{
  "description": "Manifests is a list of manifests available in this image.\nIt provides a more detailed view of the platform-specific image manifests\nor other image-attached data like build attestations.\n\nWARNING: This is experimental and may change at any time without any backward\ncompatibility.\n",
  "items": {
    "$ref": "#/components/schemas/ImageManifestSummary"
  },
  "type": "array",
  "x-nullable": false,
  "x-omitempty": true
}
ParentId · required

Type: string

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.

All schema constraints and annotations
{
  "description": "ID of the parent image.\n\nDepending on how the image was created, this field may be empty and\nis only set for images that were built/created locally. This field\nis empty if the image was pulled from an image registry.\n",
  "example": "",
  "type": "string",
  "x-nullable": false
}
RepoDigests · required

Type: array

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.

Array item

Type: string

All schema constraints and annotations
{
  "type": "string"
}
All schema constraints and annotations
{
  "description": "List of content-addressable digests of locally available image manifests\nthat the image is referenced from. Multiple manifests can refer to the\nsame image.\n\nThese digests are usually only available if the image was either pulled\nfrom a registry, or if the image was pushed to a registry, which is when\nthe manifest is generated and its digest calculated.\n",
  "example": [
    "example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb",
    "internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578"
  ],
  "items": {
    "type": "string"
  },
  "type": "array",
  "x-nullable": false
}
RepoTags · required

Type: array

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.

Array item

Type: string

All schema constraints and annotations
{
  "type": "string"
}
All schema constraints and annotations
{
  "description": "List of image names/tags in the local image cache that reference this\nimage.\n\nMultiple image tags can refer to the same image, and this list may be\nempty if no tags reference the image, in which case the image is\n\"untagged\", in which case it can still be referenced by its ID.\n",
  "example": [
    "example:1.0",
    "example:latest",
    "example:stable",
    "internal.registry.example.com:5000/example:1.0"
  ],
  "items": {
    "type": "string"
  },
  "type": "array",
  "x-nullable": false
}
SharedSize · required

Type: integer

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.

All schema constraints and annotations
{
  "description": "Total size of image layers that are shared between this image and other\nimages.\n\nThis size is not calculated by default. `-1` indicates that the value\nhas not been set / calculated.\n",
  "example": 1239828,
  "format": "int64",
  "type": "integer",
  "x-nullable": false
}
Size · required

Type: integer

Total size of the image including all layers it is composed of.
All schema constraints and annotations
{
  "description": "Total size of the image including all layers it is composed of.\n",
  "example": 172064416,
  "format": "int64",
  "type": "integer",
  "x-nullable": false
}
All schema constraints and annotations
{
  "properties": {
    "Containers": {
      "description": "Number of containers using this image. Includes both stopped and running\ncontainers.\n\n`-1` indicates that the value has not been set / calculated.\n",
      "example": 2,
      "type": "integer",
      "x-nullable": false
    },
    "Created": {
      "description": "Date and time at which the image was created as a Unix timestamp\n(number of seconds since EPOCH).\n",
      "example": "1644009612",
      "type": "integer",
      "x-nullable": false
    },
    "Descriptor": {
      "$ref": "#/components/schemas/OCIDescriptor",
      "description": "Descriptor is an OCI descriptor of the image target.\nIn case of a multi-platform image, this descriptor points to the OCI index\nor a manifest list.\n\nThis field is only present if the daemon provides a multi-platform image store.\n\nWARNING: This is experimental and may change at any time without any backward\ncompatibility.\n",
      "x-nullable": true
    },
    "Id": {
      "description": "ID is the content-addressable ID of an image.\n\nThis identifier is a content-addressable digest calculated from the\nimage's configuration (which includes the digests of layers used by\nthe image).\n\nNote that this digest differs from the `RepoDigests` below, which\nholds digests of image manifests that reference the image.\n",
      "example": "sha256:ec3f0931a6e6b6855d76b2d7b0be30e81860baccd891b2e243280bf1cd8ad710",
      "type": "string",
      "x-nullable": false
    },
    "Labels": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "User-defined key/value metadata.",
      "example": {
        "com.example.some-label": "some-value",
        "com.example.some-other-label": "some-other-value"
      },
      "type": "object",
      "x-nullable": false
    },
    "Manifests": {
      "description": "Manifests is a list of manifests available in this image.\nIt provides a more detailed view of the platform-specific image manifests\nor other image-attached data like build attestations.\n\nWARNING: This is experimental and may change at any time without any backward\ncompatibility.\n",
      "items": {
        "$ref": "#/components/schemas/ImageManifestSummary"
      },
      "type": "array",
      "x-nullable": false,
      "x-omitempty": true
    },
    "ParentId": {
      "description": "ID of the parent image.\n\nDepending on how the image was created, this field may be empty and\nis only set for images that were built/created locally. This field\nis empty if the image was pulled from an image registry.\n",
      "example": "",
      "type": "string",
      "x-nullable": false
    },
    "RepoDigests": {
      "description": "List of content-addressable digests of locally available image manifests\nthat the image is referenced from. Multiple manifests can refer to the\nsame image.\n\nThese digests are usually only available if the image was either pulled\nfrom a registry, or if the image was pushed to a registry, which is when\nthe manifest is generated and its digest calculated.\n",
      "example": [
        "example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb",
        "internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578"
      ],
      "items": {
        "type": "string"
      },
      "type": "array",
      "x-nullable": false
    },
    "RepoTags": {
      "description": "List of image names/tags in the local image cache that reference this\nimage.\n\nMultiple image tags can refer to the same image, and this list may be\nempty if no tags reference the image, in which case the image is\n\"untagged\", in which case it can still be referenced by its ID.\n",
      "example": [
        "example:1.0",
        "example:latest",
        "example:stable",
        "internal.registry.example.com:5000/example:1.0"
      ],
      "items": {
        "type": "string"
      },
      "type": "array",
      "x-nullable": false
    },
    "SharedSize": {
      "description": "Total size of image layers that are shared between this image and other\nimages.\n\nThis size is not calculated by default. `-1` indicates that the value\nhas not been set / calculated.\n",
      "example": 1239828,
      "format": "int64",
      "type": "integer",
      "x-nullable": false
    },
    "Size": {
      "description": "Total size of the image including all layers it is composed of.\n",
      "example": 172064416,
      "format": "int64",
      "type": "integer",
      "x-nullable": false
    }
  },
  "required": [
    "Id",
    "ParentId",
    "RepoTags",
    "RepoDigests",
    "Created",
    "Size",
    "SharedSize",
    "Labels",
    "Containers"
  ],
  "type": "object",
  "x-go-name": "Summary"
}