Path parameters

• name string Required

  Image name or id

Query parameters

• manifests boolean

  Include Manifests in the image summary.

  Default value is false.

Responses

• 200 application/json

  No error

  Hide response attributes Show response attributes object

  • Id 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.

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

  • Manifests array[object]

    Manifests is a list of image 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.

    Only available if the daemon provides a multi-platform image store and the manifests option is set in the inspect request.

    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.

  • RepoTags array[string]

    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]

    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.

  • Parent 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.

  • Comment string

    Optional message that was set when committing or importing the image.

  • Created string(dateTime)

    Date and time at which the image was created, formatted in RFC 3339 format with nano-seconds.

    This information is only available if present in the image, and omitted otherwise.

  • DockerVersion string

    The version of Docker that was used to build the image.

    Depending on how the image was created, this field may be empty.

  • Author string

    Name of the author that was specified when committing the image, or as specified through MAINTAINER (deprecated) in the Dockerfile.

  • Config object

    Configuration of the image. These fields are used as defaults when starting a container from the image.

    Hide Config attributes Show Config attributes object

    • Hostname string

      The hostname to use for the container, as a valid RFC 1123 hostname.

      
      

      Deprecated: this field is not part of the image specification and is always empty. It must not be used, and will be removed in API v1.48.

    • Domainname string

      The domain name to use for the container.

      
      

      Deprecated: this field is not part of the image specification and is always empty. It must not be used, and will be removed in API v1.48.

    • User string

      The user that commands are run as inside the container.

    • AttachStdin boolean

      Whether to attach to stdin.

      
      

      Deprecated: this field is not part of the image specification and is always false. It must not be used, and will be removed in API v1.48.

      Default value is false.

    • AttachStdout boolean

      Whether to attach to stdout.

      
      

      Deprecated: this field is not part of the image specification and is always false. It must not be used, and will be removed in API v1.48.

      Default value is false.

    • AttachStderr boolean

      Whether to attach to stderr.

      
      

      Deprecated: this field is not part of the image specification and is always false. It must not be used, and will be removed in API v1.48.

      Default value is false.

    • ExposedPorts object

      An object mapping ports to an empty object in the form:

      {"<port>/<tcp|udp|sctp>": {}}

      Hide ExposedPorts attribute Show ExposedPorts attribute object

      • * object Additional properties

        Default value is {} (empty).

    • Tty boolean

      Attach standard streams to a TTY, including stdin if it is not closed.

      
      

      Deprecated: this field is not part of the image specification and is always false. It must not be used, and will be removed in API v1.48.

      Default value is false.

    • OpenStdin boolean

      Open stdin

      
      

      Deprecated: this field is not part of the image specification and is always false. It must not be used, and will be removed in API v1.48.

      Default value is false.

    • StdinOnce boolean

      Close stdin after one attached client disconnects.

      
      

      Deprecated: this field is not part of the image specification and is always false. It must not be used, and will be removed in API v1.48.

      Default value is false.

    • Env array[string]

      A list of environment variables to set inside the container in the form ["VAR=value", ...]. A variable without = is removed from the environment, rather than to have an empty value.

    • Cmd array[string]

      Command to run specified as a string or an array of strings.

    • Healthcheck object

      A test to perform to check that the container is healthy.

      Hide Healthcheck attributes Show Healthcheck attributes object

      • Test array[string]

        The test to perform. Possible values are:

        • [] inherit healthcheck from image or parent image
        • ["NONE"] disable healthcheck
        • ["CMD", args...] exec arguments directly
        • ["CMD-SHELL", command] run command with system's default shell
      • Interval integer(int64)

        The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit.

      • Timeout integer(int64)

        The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit.

      • Retries integer

        The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit.

      • StartPeriod integer(int64)

        Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit.

      • StartInterval integer(int64)

        The time to wait between checks in nanoseconds during the start period. It should be 0 or at least 1000000 (1 ms). 0 means inherit.

    • ArgsEscaped boolean

      Command is already escaped (Windows only)

      Default value is false.

    • Image string

      The name (or reference) of the image to use when creating the container, or which was used when the container was created.

      
      

      Deprecated: this field is not part of the image specification and is always empty. It must not be used, and will be removed in API v1.48.

      Default value is empty.

    • Volumes object

      An object mapping mount point paths inside the container to empty objects.

      Hide Volumes attribute Show Volumes attribute object

      • * object Additional properties

        Default value is {} (empty).

    • WorkingDir string

      The working directory for commands to run in.

    • Entrypoint array[string]

      The entry point for the container as a string or an array of strings.

      If the array consists of exactly one empty string ([""]) then the entry point is reset to system default (i.e., the entry point used by docker when there is no ENTRYPOINT instruction in the Dockerfile).

    • NetworkDisabled boolean

      Disable networking for the container.

      
      

      Deprecated: this field is not part of the image specification and is always omitted. It must not be used, and will be removed in API v1.48.

      Default value is false.

    • MacAddress string

      MAC address of the container.

      
      

      Deprecated: this field is not part of the image specification and is always omitted. It must not be used, and will be removed in API v1.48.

      Default value is empty.

    • OnBuild array[string]

      ONBUILD metadata that were defined in the image's Dockerfile.

    • Labels object

      User-defined key/value metadata.

      Hide Labels attribute Show Labels attribute object

      • * string Additional properties
    • StopSignal string

      Signal to stop a container as a string or unsigned integer.

    • StopTimeout integer

      Timeout to stop a container in seconds.

      
      

      Deprecated: this field is not part of the image specification and is always omitted. It must not be used, and will be removed in API v1.48.

      Default value is 10.

    • Shell array[string]

      Shell for when RUN, CMD, and ENTRYPOINT uses a shell.

  • Architecture string

    Hardware CPU architecture that the image runs on.

  • Variant string

    CPU architecture variant (presently ARM-only).

  • Os string

    Operating System the image is built to run on.

  • OsVersion string

    Operating System version the image is built to run on (especially for Windows).

  • Size integer(int64)

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

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

  • GraphDriver object

    Information about the storage driver used to store the container's and image's filesystem.

    Hide GraphDriver attributes Show GraphDriver attributes object

    • Name string Required

      Name of the storage driver.

    • Data object Required

      Low-level storage metadata, provided as key/value pairs.

      This information is driver-specific, and depends on the storage-driver in use, and should be used for informational purposes only.

      Hide Data attribute Show Data attribute object

      • * string Additional properties
  • RootFS object

    Information about the image's RootFS, including the layer IDs.

    Hide RootFS attributes Show RootFS attributes object

    • Type string Required
    • Layers array[string]
  • Metadata object

    Additional metadata of the image in the local cache. This information is local to the daemon, and not part of the image itself.

    Hide Metadata attribute Show Metadata attribute object

    • LastTagTime string(dateTime)

      Date and time at which the image was last tagged in RFC 3339 format with nano-seconds.

      This information is only available if the image was tagged locally, and omitted otherwise.

• 404 application/json

  No such image

  Hide response attribute Show response attribute object

  • message string Required

    The error message.

• 500 application/json

  Server error

  Hide response attribute Show response attribute object

  • message string Required

    The error message.