API Reference ex_docker_api v1.55.0

API calls for all endpoints tagged Config.

API calls for all endpoints tagged Container.

API calls for all endpoints tagged Default.

API calls for all endpoints tagged Distribution.

API calls for all endpoints tagged Exec.

API calls for all endpoints tagged Image.

API calls for all endpoints tagged Network.

API calls for all endpoints tagged Node.

API calls for all endpoints tagged Plugin.

API calls for all endpoints tagged Secret.

API calls for all endpoints tagged Service.

API calls for all endpoints tagged Session.

API calls for all endpoints tagged Swarm.

API calls for all endpoints tagged System.

API calls for all endpoints tagged Task.

API calls for all endpoints tagged Volume.

Handle Tesla connections for DockerEngineAPI.

Helper functions for deserializing responses into models

Address represents an IPv4 or IPv6 IP address.

AttestationStatement is a single in-toto statement attached to an image.

An identity token was generated successfully.

BuildCache contains information about a build cache record.

represents system data usage for build cache resources.

BuildIdentity contains build reference information if image was created via build.

Kind of change Can be one of: - 0: Modified ("C") - 1: Added ("A") - 2: Deleted ("D")

ClusterInfo represents information about the swarm as is returned by the "/info" endpoint. Join-tokens are not included.

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

Information about the global status of the volume.

Cluster-specific options used to create the volume.

Defines how the volume is used by tasks.

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.

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

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

Commit holds the Git-commit (SHA1) that a binary was built from, as reported in the version-string of external tools, such as containerd, or runC.

The config-only network source to provide the configuration for this network.

Blkio stats entry. This type is Linux-specific and omitted for Windows containers.

BlkioStats stores all IO service stats for data read and write. This type is Linux-specific and holds many fields that are specific to cgroups v1. On a cgroup v2 host, all fields other than io_service_bytes_recursive are omitted or null. This type is only populated on Linux and omitted for Windows containers.

Configuration for a container that is portable between hosts.

CPU related info of the container

All CPU stats aggregated since container inception.

OK response to ContainerCreate operation

Aggregates all memory stats since container inception on Linux. Windows returns stats for commit and private working set only.

Aggregates the network stats of one container

PidsStats contains Linux-specific stats of a container's process-IDs (PIDs). This type is Linux-specific and omitted for Windows containers.

ContainerState stores container's running state. It's part of ContainerJSONBase and will be returned by the "inspect" command.

Statistics sample for a container.

represents the status of a container.

StorageStats is the disk I/O stats for read/write on Windows. This type is Windows-specific and omitted for Linux containers.

Summary of health status Added in v1.52, before that version all container summary not include Health. After this attribute introduced, it includes containers with no health checks configured, or containers that are not running with none

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.

Summary of the container's network settings

CPU throttling stats of the container. This type is Linux-specific and omitted for Windows containers.

Container "top" response.

Response for a successful container-update.

container waiting error, if any

OK response to ContainerWait operation

Information for connecting to the containerd instance that is used by the daemon. This is included for debugging purposes only.

The namespaces that the daemon uses for running containers and plugins in containerd. These namespaces can be configured in the daemon configuration, and are considered to be used exclusively by the daemon, Tampering with the containerd instance may cause unexpected behavior. As these namespaces are considered to be exclusively accessed by the daemon, it is not recommended to change these values, or to change them to a value that is used by other systems, such as cri-containerd.

represents system data usage information for container resources.

DeviceInfo represents a device that can be used by a container.

A device mapping between the host and container

A request for devices to be sent to device drivers

Describes the result obtained from contacting the registry to retrieve image metadata.

Driver represents a driver (network, logging, secrets).

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

EndpointIPAMConfig represents an endpoint's IPAM configuration.

contains network resources allocated and used for a container in a network.

Configuration for a network endpoint.

Properties that can be configured to access and load balance a service.

EngineDescription provides information about an engine.

Represents an error.

Actor describes something that generates events, like a container, network, or a volume.

EventMessage represents the information an event contains.

Change in the container's filesystem.

Information about the daemon's firewalling configuration. This field is currently only used on Linux, and omitted on other platforms.

Health stores information about the container's healthcheck results.

A test to perform to check that the container is healthy. Healthcheck commands should be side-effect free.

HealthcheckResult stores information about a single run of a healthcheck probe

individual image layer information in response to ImageHistory operation

Container configuration that depends on the host we are running on

The logging configuration for this container

Response to an API call that returns just an Id

Identity holds information about the identity and origin of the image. This is trusted information verified by the daemon and cannot be modified by tagging an image to a different name.

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

individual image layer information in response to ImageHistory operation

Image ID or Digest

Information about an image in the local image cache.

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

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

ImageManifestSummary represents a summary of an image manifest.

The image data for the attestation manifest. This field is only populated when Kind is "attestation".

The image data for the image manifest. This field is only populated when Kind is "image".

represents system data usage for image resources.

IndexInfo contains information about a registry.

JoinTokens contains the tokens workers and managers need to join the swarm.

KnownSignerIdentity is an identifier for a special signer identity that is known to the implementation.

An object describing a limit on resources which can be requested by a task.

Current local status of this node.

ManagerStatus represents the status of a manager. It provides the current status of a node's manager component, if the node is a manager.

Optional configuration for the bind type.

Optional configuration for the image type.

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

Optional configuration for the tmpfs type.

The mount type. Available types: - bind a mount of a file or directory from the host into the container. - cluster a Swarm cluster volume. - image an OCI image. - npipe a named pipe from the host into the container. - tmpfs a tmpfs. - volume a docker volume with the given Name.

Optional configuration for the volume type.

Map of driver specific options

Specifies how a service should be attached to a particular network.

NetworkConnectRequest represents the data to be used to connect a container to a network.

OK response to NetworkCreate operation

NetworkDisconnectRequest represents the data to be used to disconnect a container from a network.

NetworkSettings exposes the network settings in the API

provides runtime information about the network such as the number of allocated IPs.

Network list response item

carries the information about one backend task

NetworkingConfig represents the container's networking configuration for each of its interfaces. It is used for the networking configs specified in the docker create and docker network connect commands.

NodeDescription encapsulates the properties of the Node as reported by the agent.

NodeState represents the state of a node.

NodeStatus represents the status of a node. It provides the current status of the node, as seen by the manager.

Information about the Node Resource Interface (NRI). This field is only present if NRI is enabled.

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.

A descriptor struct containing digest, media type, and size, as defined in the OCI Content Descriptors Specification.

Describes the platform which the image in the manifest runs on, as defined in the OCI Image Index Specification.

represents one peer of an overlay network.

Represents a peer-node in the swarm

Platform represents the platform (Arch/OS).

A plugin for the Engine API

The config of a plugin.

The interface between Docker and the plugin

Describes a permission the user has to accept upon installing the plugin.

user-configurable settings for the plugin.

Available plugins per type. <p><br /></p> > Note: Only unmanaged (V1) plugins are included in this list. > V1 plugins are "lazily" loaded, and are not returned in this list > if there is no resource using the plugin.

An open port on a container

PortBinding represents a binding between a host IP address and a host port.

represents the port status of a task's host ports whose service has published host ports

Describes a port-mapping between the container and the host.

PullIdentity contains remote location information if image was created via pull. If image was pulled via mirror, this contains the original repository location.

Reachability represents the reachability of a node.

RegistryServiceConfig stores daemon registry services configuration.

An object describing the resources which can be advertised by a node and requested by a task.

A container's resources (cgroups config, ulimits, etc)

The behavior to apply when the container exits. The default is not to restart. An ever increasing delay (double the previous delay, starting at 100ms) is added before each restart to prevent flooding the server.

Information about the storage used for the container's root filesystem.

Information about a snapshot backend of the container's root filesystem.

Runtime describes an OCI compliant runtime. The runtime is invoked by the daemon via the containerd daemon. OCI runtimes act as an interface to the Linux kernel namespaces, cgroups, and SELinux.

contains the information returned to a client on the creation of a new service.

represents service parameters with the list of service's tasks

The status of the service when it is in one of ReplicatedJob or GlobalJob modes. Absent on Replicated and Global mode services. The JobIteration is an ObjectVersion, but unlike the Service's version, does not need to be sent with an update request.

The status of the service's tasks. Provided only when requested as part of a ServiceList operation.

User modifiable configuration for a service.

Scheduling mode for the service.

The mode used for services with a finite number of tasks that run to a completed state.

Specification for the rollback strategy of the service.

Specification for the update strategy of the service.

The status of a service update.

SignatureIdentity contains the properties of verified signatures for the image.

SignatureTimestamp contains information about a verified signed timestamp for an image signature.

SignatureTimestampType is the type of timestamp used in the signature.

SignatureType is the type of signature format.

SignerIdentity contains information about the signer certificate used to sign the image.

Information about the storage used by the container.

Represents generic information about swarm.

User modifiable swarm configuration.

CA configuration.

Dispatcher configuration.

Parameters related to encryption-at-rest.

Orchestration configuration.

Raft configuration.

Defaults for creating tasks in this cluster.

The log driver to use for tasks created in the orchestrator if unspecified by a service. Updating this value only affects new tasks. Existing tasks continue to use their previously configured log driver until recreated.

Response of Engine API: GET "/version"

User modifiable task configuration.

Container spec for the service. <p><br /></p> > Note: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are > mutually exclusive. PluginSpec is only used when the Runtime field > is set to plugin. NetworkAttachmentSpec is used when the Runtime > field is set to attachment.

File represents a specific target that is backed by a file. <p><br /><p> > Note: Configs.File and Configs.Runtime are mutually exclusive

Specification for DNS related configurations in resolver configuration file (resolv.conf).

Security options for the container

Options for configuring AppArmor on the container

CredentialSpec for managed service account (Windows only)

SELinux labels of the container

Options for configuring seccomp on the container

File represents a specific target that is backed by a file.

Specifies the log driver to use for tasks created from this spec. If not present, the default one for the swarm will be used, finally falling back to the engine default if not specified.

Read-only spec type for non-swarm containers attached to swarm overlay networks. <p><br /></p> > Note: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are > mutually exclusive. PluginSpec is only used when the Runtime field > is set to plugin. NetworkAttachmentSpec is used when the Runtime > field is set to attachment.

Plugin spec for the service. (Experimental release only.) <p><br /></p> > Note: ContainerSpec, NetworkAttachmentSpec, and PluginSpec are > mutually exclusive. PluginSpec is only used when the Runtime field > is set to plugin. NetworkAttachmentSpec is used when the Runtime > field is set to attachment.

Resource requirements which apply to each individual container created as part of the service.

Specification for the restart policy which applies to containers created as part of this service.

represents the status of a task.

Information about the issuer of leaf TLS certificates and the trusted root CA certificate.

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

Volume configuration

Volume configuration

Volume list response

Volume configuration

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

represents system data usage for volume resources.

Helper functions for building Tesla requests