Query parameters

• type array[string]

  Object types, for which to compute and return data.

Responses

• 200 application/json

  no error

  Hide response attributes Show response attributes object

  • LayersSize integer(int64)
  • Images array[object]
    Hide Images attributes Show Images 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 since 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.

    • Manifests array[object]

      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.

      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.

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

  • Containers array[object]
    Hide Containers attributes Show Containers attributes object

    • Id string

      The ID of this container as a 128-bit (64-character) hexadecimal string (32 bytes).

      Minimum length is 64, maximum length is 64. Format should match the following pattern: ^[0-9a-fA-F]{64}$.

    • Names array[string]

      The names associated with this container. Most containers have a single name, but when using legacy "links", the container can have multiple names.

      For historic reasons, names are prefixed with a forward-slash (/).

    • Image string

      The name or ID of the image used to create the container.

      This field shows the image reference as was specified when creating the container, which can be in its canonical form (e.g., docker.io/library/ubuntu:latest or docker.io/library/ubuntu@sha256:72297848456d5d37d1262630108ab308d3e9ec7ed1c3286a32fe09856619a782), short form (e.g., ubuntu:latest)), or the ID(-prefix) of the image (e.g., 72297848456d).

      The content of this field can be updated at runtime if the image used to create the container is untagged, in which case the field is updated to contain the the image ID (digest) it was resolved to in its canonical, non-truncated form (e.g., sha256:72297848456d5d37d1262630108ab308d3e9ec7ed1c3286a32fe09856619a782).

    • ImageID string

      The ID (digest) of the image that this container was created from.

    • ImageManifestDescriptor 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 ImageManifestDescriptor attributes Show ImageManifestDescriptor 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.

    • Command string

      Command to run when starting the container

    • Created integer(int64)

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

    • Ports array[object]

      Port-mappings for the container.

      An open port on a container

      Hide Ports attributes Show Ports attributes object

      • IP string(ip-address)

        Host IP address that the container's port is mapped to

      • PrivatePort integer(uint16) Required

        Port on the container

      • PublicPort integer(uint16)

        Port exposed on the host

      • Type string Required

        Values are tcp, udp, or sctp.

    • SizeRw integer(int64)

      The size of files that have been created or changed by this container.

      This field is omitted by default, and only set when size is requested in the API request.

    • SizeRootFs integer(int64)

      The total size of all files in the read-only layers from the image that the container uses. These layers can be shared between containers.

      This field is omitted by default, and only set when size is requested in the API request.

    • Labels object

      User-defined key/value metadata.

      Hide Labels attribute Show Labels attribute object

      • * string Additional properties
    • State string

      The state of this container.

      Values are created, running, paused, restarting, exited, removing, or dead.

    • Status string

      Additional human-readable status of this container (e.g. Exit 0)

    • HostConfig object

      Summary of host-specific runtime information of the container. This is a reduced set of information in the container's "HostConfig" as available in the container "inspect" response.

      Hide HostConfig attributes Show HostConfig attributes object

      • NetworkMode string

        Networking mode (host, none, container:<id>) or name of the primary network the container is using.

        This field is primarily for backward compatibility. The container can be connected to multiple networks for which information can be found in the NetworkSettings.Networks field, which enumerates settings per network.

      • Annotations object

        Arbitrary key-value metadata attached to the container.

        Hide Annotations attribute Show Annotations attribute object

        • * string Additional properties
    • NetworkSettings object

      Summary of the container's network settings

      Hide NetworkSettings attribute Show NetworkSettings attribute object

      • Networks object

        Summary of network-settings for each network the container is attached to.

        Hide Networks attribute Show Networks attribute object

        • * object Additional properties

          Configuration for a network endpoint.

          Hide * attributes Show * attributes object

          • IPAMConfig object

            EndpointIPAMConfig represents an endpoint's IPAM configuration.

            Hide IPAMConfig attributes Show IPAMConfig attributes object

            • IPv4Address string
            • IPv6Address string
            • LinkLocalIPs array[string]
          • Links array[string]
          • MacAddress string

            MAC address for the endpoint on this network. The network driver might ignore this parameter.

          • Aliases array[string]
          • DriverOpts object

            DriverOpts is a mapping of driver options and values. These options are passed directly to the driver and are driver specific.

            Hide DriverOpts attribute Show DriverOpts attribute object

            • * string Additional properties
          • GwPriority number

            This property determines which endpoint will provide the default gateway for a container. The endpoint with the highest priority will be used. If multiple endpoints have the same priority, endpoints are lexicographically sorted based on their network name, and the one that sorts first is picked.

          • NetworkID string

            Unique ID of the network.

          • EndpointID string

            Unique ID for the service endpoint in a Sandbox.

          • Gateway string

            Gateway address for this network.

          • IPAddress string

            IPv4 address.

          • IPPrefixLen integer

            Mask length of the IPv4 address.

          • IPv6Gateway string

            IPv6 gateway address.

          • GlobalIPv6Address string

            Global IPv6 address.

          • GlobalIPv6PrefixLen integer(int64)

            Mask length of the global IPv6 address.

          • DNSNames array[string]

            List of all DNS names an endpoint has on a specific network. This list is based on the container name, network aliases, container short ID, and hostname.

            These DNS names are non-fully qualified but can contain several dots. You can get fully qualified DNS names by appending .<network-name>. For instance, if container name is my.ctr and the network is named testnet, DNSNames will contain my.ctr and the FQDN will be my.ctr.testnet.

    • Mounts array[object]

      List of mounts used by the container.

      MountPoint represents a mount point configuration inside the container. This is used for reporting the mountpoints in use by a container.

      Hide Mounts attributes Show Mounts attributes object

      • Type string

        The mount type:

        • bind a mount of a file or directory from the host into the container.
        • volume a docker volume with the given Name.
        • image a docker image
        • tmpfs a tmpfs.
        • npipe a named pipe from the host into the container.
        • cluster a Swarm cluster volume

        Values are bind, volume, image, tmpfs, npipe, or cluster.

      • Name string

        Name is the name reference to the underlying data defined by Source e.g., the volume name.

      • Source string

        Source location of the mount.

        For volumes, this contains the storage location of the volume (within /var/lib/docker/volumes/). For bind-mounts, and npipe, this contains the source (host) part of the bind-mount. For tmpfs mount points, this field is empty.

      • Destination string

        Destination is the path relative to the container root (/) where the Source is mounted inside the container.

      • Driver string

        Driver is the volume driver used to create the volume (if it is a volume).

      • Mode string

        Mode is a comma separated list of options supplied by the user when creating the bind/volume mount.

        The default is platform-specific ("z" on Linux, empty on Windows).

      • RW boolean

        Whether the mount is mounted writable (read-write).

      • Propagation string

        Propagation describes how mounts are propagated from the host into the mount point, and vice-versa. Refer to the Linux kernel documentation for details. This field is not used on Windows.

  • Volumes array[object]
    Hide Volumes attributes Show Volumes attributes object

    • Name string Required

      Name of the volume.

    • Driver string Required

      Name of the volume driver used by the volume.

    • Mountpoint string Required

      Mount path of the volume on the host.

    • CreatedAt string(dateTime)

      Date/Time the volume was created.

    • Status object

      Low-level details about the volume, provided by the volume driver. Details are returned as a map with key/value pairs: {"key":"value","key2":"value2"}.

      The Status field is optional, and is omitted if the volume driver does not support this feature.

      Hide Status attribute Show Status attribute object

      • * object Additional properties
    • Labels object Required

      User-defined key/value metadata.

      Hide Labels attribute Show Labels attribute object

      • * string Additional properties
    • Scope string Required

      The level at which the volume exists. Either global for cluster-wide, or local for machine level.

      Values are local or global. Default value is local.

    • ClusterVolume object

      Options and information specific to, and only present on, Swarm CSI cluster volumes.

      Hide ClusterVolume attributes Show ClusterVolume attributes object

      • ID string

        The Swarm ID of this volume. Because cluster volumes are Swarm objects, they have an ID, unlike non-cluster volumes. This ID can be used to refer to the Volume instead of the name.

      • Version object

        The version number of the object such as node, service, etc. This is needed to avoid conflicting writes. The client must send the version number along with the modified specification when updating these objects.

        This approach ensures safe concurrency and determinism in that the change on the object may not be applied if the version number has changed from the last read. In other words, if two update requests specify the same base version, only one of the requests can succeed. As a result, two separate update requests that happen at the same time will not unintentionally overwrite each other.

        Hide Version attribute Show Version attribute object

        • Index integer(uint64)
      • CreatedAt string(dateTime)
      • UpdatedAt string(dateTime)
      • Spec object

        Cluster-specific options used to create the volume.

        Hide Spec attributes Show Spec attributes object

        • Group string

          Group defines the volume group of this volume. Volumes belonging to the same group can be referred to by group name when creating Services. Referring to a volume by group instructs Swarm to treat volumes in that group interchangeably for the purpose of scheduling. Volumes with an empty string for a group technically all belong to the same, emptystring group.

        • AccessMode object

          Defines how the volume is used by tasks.

          Hide AccessMode attributes Show AccessMode attributes object

          • Scope string

            The set of nodes this volume can be used on at one time.

            • single The volume may only be scheduled to one node at a time.
            • multi the volume may be scheduled to any supported number of nodes at a time.

            Values are single or multi. Default value is single.

          • Sharing string

            The number and way that different tasks can use this volume at one time.

            • none The volume may only be used by one task at a time.
            • readonly The volume may be used by any number of tasks, but they all must mount the volume as readonly
            • onewriter The volume may be used by any number of tasks, but only one may mount it as read/write.
            • all The volume may have any number of readers and writers.

            Values are none, readonly, onewriter, or all. Default value is none.

          • MountVolume object

            Options for using this volume as a Mount-type volume.

            Either MountVolume or BlockVolume, but not both, must be present. properties: FsType: type: "string" description: | Specifies the filesystem type for the mount volume. Optional. MountFlags: type: "array" description: | Flags to pass when mounting the volume. Optional. items: type: "string" BlockVolume: type: "object" description: | Options for using this volume as a Block-type volume. Intentionally empty.

          • Secrets array[object]

            Swarm Secrets that are passed to the CSI storage plugin when operating on this volume.

            One cluster volume secret entry. Defines a key-value pair that is passed to the plugin.

            Hide Secrets attributes Show Secrets attributes object

            • Key string

              Key is the name of the key of the key-value pair passed to the plugin.

            • Secret string

              Secret is the swarm Secret object from which to read data. This can be a Secret name or ID. The Secret data is retrieved by swarm and used as the value of the key-value pair passed to the plugin.

          • AccessibilityRequirements object

            Requirements for the accessible topology of the volume. These fields are optional. For an in-depth description of what these fields mean, see the CSI specification.

            Hide AccessibilityRequirements attributes Show AccessibilityRequirements attributes object

            • Requisite array[object]

              A list of required topologies, at least one of which the volume must be accessible from.

              A map of topological domains to topological segments. For in depth details, see documentation for the Topology object in the CSI specification.

              Hide Requisite attribute Show Requisite attribute object

              • * string Additional properties
            • Preferred array[object]

              A list of topologies that the volume should attempt to be provisioned in.

              A map of topological domains to topological segments. For in depth details, see documentation for the Topology object in the CSI specification.

              Hide Preferred attribute Show Preferred attribute object

              • * string Additional properties
          • CapacityRange object

            The desired capacity that the volume should be created with. If empty, the plugin will decide the capacity.

            Hide CapacityRange attributes Show CapacityRange attributes object

            • RequiredBytes integer(int64)

              The volume must be at least this big. The value of 0 indicates an unspecified minimum

            • LimitBytes integer(int64)

              The volume must not be bigger than this. The value of 0 indicates an unspecified maximum.

          • Availability string

            The availability of the volume for use in tasks.

            • active The volume is fully available for scheduling on the cluster
            • pause No new workloads should use the volume, but existing workloads are not stopped.
            • drain All workloads using this volume should be stopped and rescheduled, and no new ones should be started.

            Values are active, pause, or drain. Default value is active.

      • Info object

        Information about the global status of the volume.

        Hide Info attributes Show Info attributes object

        • CapacityBytes integer(int64)

          The capacity of the volume in bytes. A value of 0 indicates that the capacity is unknown.

        • VolumeContext object

          A map of strings to strings returned from the storage plugin when the volume is created.

          Hide VolumeContext attribute Show VolumeContext attribute object

          • * string Additional properties
        • VolumeID string

          The ID of the volume as returned by the CSI storage plugin. This is distinct from the volume's ID as provided by Docker. This ID is never used by the user when communicating with Docker to refer to this volume. If the ID is blank, then the Volume has not been successfully created in the plugin yet.

        • AccessibleTopology array[object]

          The topology this volume is actually accessible from.

          A map of topological domains to topological segments. For in depth details, see documentation for the Topology object in the CSI specification.

          Hide AccessibleTopology attribute Show AccessibleTopology attribute object

          • * string Additional properties
      • PublishStatus array[object]

        The status of the volume as it pertains to its publishing and use on specific nodes

        Hide PublishStatus attributes Show PublishStatus attributes object

        • NodeID string

          The ID of the Swarm node the volume is published on.

        • State string

          The published state of the volume.

          • pending-publish The volume should be published to this node, but the call to the controller plugin to do so has not yet been successfully completed.
          • published The volume is published successfully to the node.
          • pending-node-unpublish The volume should be unpublished from the node, and the manager is awaiting confirmation from the worker that it has done so.
          • pending-controller-unpublish The volume is successfully unpublished from the node, but has not yet been successfully unpublished on the controller.

          Values are pending-publish, published, pending-node-unpublish, or pending-controller-unpublish.

        • PublishContext object

          A map of strings to strings returned by the CSI controller plugin when a volume is published.

          Hide PublishContext attribute Show PublishContext attribute object

          • * string Additional properties
    • Options object Required

      The driver specific options used when creating the volume.

      Hide Options attribute Show Options attribute object

      • * string Additional properties
    • UsageData object

      Usage details about the volume. This information is used by the GET /system/df endpoint, and omitted in other endpoints.

      Hide UsageData attributes Show UsageData attributes object

      • Size integer(int64) Required

        Amount of disk space used by the volume (in bytes). This information is only available for volumes created with the "local" volume driver. For volumes created with other volume drivers, this field is set to -1 ("not available")

        Default value is -1.

      • RefCount integer(int64) Required

        The number of containers referencing this volume. This field is set to -1 if the reference-count is not available.

        Default value is -1.

  • BuildCache array[object]

    BuildCache contains information about a build cache record.

    Hide BuildCache attributes Show BuildCache attributes object

    • ID string

      Unique ID of the build cache record.

    • Parent string

      ID of the parent build cache record.

      Deprecated: This field is deprecated, and omitted if empty.

    • Parents array[string]

      List of parent build cache record IDs.

    • Type string

      Cache record type.

      Values are internal, frontend, source.local, source.git.checkout, exec.cachemount, or regular.

    • Description string

      Description of the build-step that produced the build cache.

    • InUse boolean

      Indicates if the build cache is in use.

    • Shared boolean

      Indicates if the build cache is shared.

    • Size integer

      Amount of disk space used by the build cache (in bytes).

    • CreatedAt string(dateTime)

      Date and time at which the build cache was created in RFC 3339 format with nano-seconds.

    • LastUsedAt string(dateTime)

      Date and time at which the build cache was last used in RFC 3339 format with nano-seconds.

    • UsageCount integer
• 500 application/json

  server error

  Hide response attribute Show response attribute object

  • message string Required

    The error message.