Path parameters

• name string Required

  Image name or id

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.

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

  • Container string

    The ID of the container that was used to create the image.

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

    Deprecated: this field is kept for backward compatibility, but will be removed in API v1.45.

  • ContainerConfig object

    Deprecated: this field is kept for backward compatibility, but will be removed in API v1.45.

    Hide ContainerConfig attributes Show ContainerConfig attributes object

    • Hostname string

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

    • Domainname string

      The domain name to use for the container.

    • User string

      The user that commands are run as inside the container.

    • AttachStdin boolean

      Whether to attach to stdin.

      Default value is false.

    • AttachStdout boolean

      Whether to attach to stdout.

      Default value is true.

    • AttachStderr boolean

      Whether to attach to stderr.

      Default value is true.

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

      Default value is false.

    • OpenStdin boolean

      Open stdin

      Default value is false.

    • StdinOnce boolean

      Close stdin after one attached client disconnects

      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.

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

    • MacAddress string

      MAC address of the container.

      Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead.

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

      Default value is 10.

    • Shell array[string]

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

  • 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

    Deprecated: this field is kept for backward compatibility, but will be removed in API v1.45.

    Hide Config attributes Show Config attributes object

    • Hostname string

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

    • Domainname string

      The domain name to use for the container.

    • User string

      The user that commands are run as inside the container.

    • AttachStdin boolean

      Whether to attach to stdin.

      Default value is false.

    • AttachStdout boolean

      Whether to attach to stdout.

      Default value is true.

    • AttachStderr boolean

      Whether to attach to stderr.

      Default value is true.

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

      Default value is false.

    • OpenStdin boolean

      Open stdin

      Default value is false.

    • StdinOnce boolean

      Close stdin after one attached client disconnects

      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.

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

    • MacAddress string

      MAC address of the container.

      Deprecated: this field is deprecated in API v1.44 and up. Use EndpointSettings.MacAddress instead.

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

      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.