Address represents an IPv4 or IPv6 IP address.
BuildCache contains information about a build cache record.
No error
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.
change item in response to ContainerChanges operation
Configuration for a container that is portable between hosts.
Configuration for a container that is portable between hosts.
OK response to ContainerCreate operation
no error
No error
ContainerState stores container’s running state. It’s part of ContainerJSONBase
and will be returned by the “inspect” command.
A summary of the container’s network settings
no error
The container has been updated.
A container’s resources (cgroups config, ulimits, etc)
container waiting error, if any
OK response to ContainerWait operation
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).
EndpointIPAMConfig represents an endpoint’s IPAM configuration.
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.
No error
Information about the storage driver used to store the container’s and
image’s filesystem.
Health stores information about the container’s healthcheck results.
A test to perform to check that the container is healthy.
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
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.
No error
IndexInfo contains information about a registry.
JoinTokens contains the tokens workers and managers need to join the swarm.
An object describing a limit on resources which can be requested by a task.
ManagerStatus represents the status of a manager.
Optional configuration for the bind 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.
Optional configuration for the volume type.
Map of driver specific options
Specifies how a service should be attached to a particular network.
No error
No error
NetworkSettings exposes the network settings in the API
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.
NodeStatus represents the status of a node.
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.
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.
Settings that can be modified by users.
Available plugins per type.
An open port on a container
PortBinding represents a binding between a host IP address and a host
port.
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.
no error
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 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.
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.
ClusterInfo represents information about the swarm as is returned by the
“/info” endpoint. Join-tokens are not included.
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.
no error
An identity token was generated successfully.
no error
Response of Engine API: GET “/version”
User modifiable task configuration.
Container spec for the service.
File represents a specific target that is backed by a file.
Specification for DNS related configurations in resolver configuration
file (resolv.conf).
Security options for the container
CredentialSpec for managed service account (Windows only)
SELinux labels of 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.
Plugin spec for the service. (Experimental release only.)
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.
Information about the issuer of leaf TLS certificates and the trusted root
CA certificate.
Usage details about the volume. This information is used by the
GET /system/df endpoint, and omitted in other endpoints.
Volume configuration
Volume list response
No error
Volume configuration
Cache record type.
The published state of the volume.
The availability of the volume for use in tasks.
The set of nodes this volume can be used on at one time.
The number and way that different tasks can use this volume
at one time.
String representation of the container state. Can be one of “created”,
“running”, “paused”, “restarting”, “removing”, “exited”, or “dead”.
The mode in which port is published.
The mode of resolution to use for internal load balancing between tasks.
The type of object emitting the event
Scope of the event. Engine events are local scope. Cluster (Swarm)
events are swarm scope.
Status is one of none, starting, healthy or unhealthy
cgroup namespace mode for the container. Possible values are:
Isolation technology of the container. (Windows only)
Current local status of this node.
A propagation mode with the value [r]private, [r]shared, or [r]slave.
The mount type:
The mount type. Available types:
Availability of the node.
Role of the node.
NodeState represents the state of a node.
Protocol to use for clients connecting to the plugin.
Reachability represents the reachability of a node.
- Empty string means not to restart
no Do not automatically restartalways Always restartunless-stopped Restart always except when the user has manually stopped the containeron-failure Restart only when the container exit code is non-zeroAction to take if an rolled back task fails to run, or stops
running during the rollback.
The order of operations when rolling back a task. Either the old
task is shut down before the new task is started, or the new task
is started before the old task is shut down.
Action to take if an updated task fails to run, or stops running
during the update.
The order of operations when rolling out an updated task. Either
the old task is shut down before the new task is started, or the
new task is started before the old task is shut down.
Action to take if an rolled back task fails to run, or stops
running during the rollback.
The order of operations when rolling back a task. Either the old
task is shut down before the new task is started, or the new task
is started before the old task is shut down.
Action to take if an updated task fails to run, or stops running
during the update.
The order of operations when rolling out an updated task. Either
the old task is shut down before the new task is started, or the
new task is started before the old task is shut down.
Action to take if an rolled back task fails to run, or stops
running during the rollback.
The order of operations when rolling back a task. Either the old
task is shut down before the new task is started, or the new task
is started before the old task is shut down.
Action to take if an updated task fails to run, or stops running
during the update.
The order of operations when rolling out an updated task. Either
the old task is shut down before the new task is started, or the
new task is started before the old task is shut down.
Protocol for communication with the external CA (currently
only cfssl is supported).
The driver to use for managing cgroups.
The version of the cgroup.
Represents the isolation technology to use as a default for containers.
The supported values are platform-specific.
Isolation technology of the containers running the service.
(Windows only)
Condition for restart.
The level at which the volume exists. Either global for cluster-wide,
or local for machine level.