The Universal Control Plane API is a REST API, available using HTTPS, that enables programmatic access to swarm resources that are managed by UCP. UCP exposes the full Docker Engine API, so you can extend your existing code with UCP features. The API is secured with role-based access control so that only authorized users can make changes and deploy applications to your Docker swarm.
The UCP API is accessible in the same IP addresses and domain names that you use to access the web UI. It's the same API that the UCP web UI uses, so everything you can do on the UCP web UI from your browser, you can also do programmatically.
The system manages swarm resources by using collections, which you access through the /collection endpoint. For example, GET /defaultCollection/<userid> retrieves the default collection for a user. Learn more about resource collections.
The /roles endpoint lets you enumerate and create custom permissions for accessing collections.
The /accounts endpoint enables managing users, teams, and organizations.
The /configs endpoint gives you access to the swarm's configuration.
Create a public key for an account.
Requires authentication and authorization as an admin user, the target user (if
a user), or an admin member of the target organization (if an organization).
Remove an account public key.
Requires authentication and authorization as an admin user, the target user (if
a user), or an admin member of the target organization (if an organization).
Update details for an account public key.
Requires authentication and authorization as an admin user, the target user (if
a user), or an admin member of the target organization (if an organization).
List user and organization accounts.
Lists information about user and organization accounts. Supports sorting and
filtering.
Requires authentication and authorization as any user.
List of results for the bulk operation. The index of a bulk result corresponds to the index of the resource in the bulk request if result identifiers are omitted
} responses.BulkResult {
error (errors.APIError, optional):
If not successful, the error encountered when performing the operation on this resource
,
op (string):
The operation which was perfomed
,
ref (string, optional):
The corresponding identifier in the bulk operation request
,
success (boolean):
Whether the bulk operation was successful for this resource
Create a user or organization account.
To search for and import a user from an LDAP directory, the system must be
configured with LDAP integration.
Requires authentication and authorization as an admin user.
Delete a user or organization account.
If the system is configured to import users from an LDAP directory, the user
may be created again if they still match the current LDAP search config.
Requires authentication and authorization as an admin user.
Update details for a user or organization account.
Requires authentication and authorization as an admin user, the target user (if
a user), or an admin member of the target organization (if an organization).
Create a public key for an account.
Requires authentication and authorization as an admin user, the target user (if
a user), or an admin member of the target organization (if an organization).
Remove an account public key.
Requires authentication and authorization as an admin user, the target user (if
a user), or an admin member of the target organization (if an organization).
Update details for an account public key.
Requires authentication and authorization as an admin user, the target user (if
a user), or an admin member of the target organization (if an organization).
Get options for syncing admin members of an organization.
Requires authentication and authorization as an admin user or an admin member
of the organization.
Whether to enable LDAP syncing. If false, all other fields are ignored
,
groupDN (string):
The distinguished name of the LDAP group. Applicable only if selectGroupMembers is true, ignored otherwise
,
groupMemberAttr (string):
The name of the LDAP group entry attribute which corresponds to distinguished names of members. Applicable only if selectGroupMembers is true, ignored otherwise
,
searchBaseDN (string):
The distinguished name of the element from which the LDAP server will search for users. Applicable only if selectGroupMembers is false, ignored otherwise
,
searchFilter (string):
The LDAP search filter used to select users if selectGroupMembers is false, may be left blank
,
searchScopeSubtree (boolean):
Whether to search for users in the entire subtree of the base DN or to only search one level under the base DN (if false). Applicable only if selectGroupMembers is false, ignored otherwise
,
selectGroupMembers (boolean):
Whether to sync using a group DN and member attribute selection or to use a search filter (if false)
Set options for syncing admin members of an organization.
Enabling sync of organization admin members will disable the ability to
directly manage organization membership for any users imported from an LDAP
directory. Their organization membership is instead set by being synced as an
admin member of the organization or by being a member of any team within the
organization.
Requires authentication and authorization as an admin user or an admin member
of the organization.
Whether to enable LDAP syncing. If false, all other fields are ignored
,
groupDN (string):
The distinguished name of the LDAP group. Applicable only if selectGroupMembers is true, ignored otherwise
,
groupMemberAttr (string):
The name of the LDAP group entry attribute which corresponds to distinguished names of members. Applicable only if selectGroupMembers is true, ignored otherwise
,
searchBaseDN (string):
The distinguished name of the element from which the LDAP server will search for users. Applicable only if selectGroupMembers is false, ignored otherwise
,
searchFilter (string):
The LDAP search filter used to select users if selectGroupMembers is false, may be left blank
,
searchScopeSubtree (boolean):
Whether to search for users in the entire subtree of the base DN or to only search one level under the base DN (if false). Applicable only if selectGroupMembers is false, ignored otherwise
,
selectGroupMembers (boolean):
Whether to sync using a group DN and member attribute selection or to use a search filter (if false)
List members of an organization.
Lists memberships in ascending order by user ID.
Requires authentication and authorization as an admin user or a member of the
organization.
Remove a user from an organization.
Removing a member of the organization will also remove them from any teams in
the organization. If organization admin members are configured to be synced
with LDAP, users which are imported from LDAP cannot be manually removed as
members of the organization and must be either synced as an organization admin
member or removed as a member of all teams within the organization.
Requires authentication and authorization as an admin user or an admin member
of the organization.
Details of a user's membership in an organization.
Requires authentication and authorization as an admin user, a member of the
organization, or the target user.
Add a user to an organization.
If organization admin members are configured to be synced with LDAP, users
which are imported from LDAP cannot be manually added as members of the
organization and must be either synced as an organization admin member or be
added as a member of team within the organization.
Requires authentication and authorization as an admin user or an admin member
of the organization
List a user's team membership in an organization.
Lists team memberships in ascending order by team ID.
Requires authentication and authorization as an admin user or a member of the
organization.
List teams in an organization.
Lists teams in ascending order by name.
Requires authentication and authorization as an admin user or a member of the
organization.
Update details for a team.
Requires authentication and authorization as an admin user, an admin member of
the organization, or an admin member of the team.
Get options for syncing members of a team.
Requires authentication and authorization as an admin user, an admin member of
the organization, or an admin member of the team.
Whether to enable LDAP syncing. If false, all other fields are ignored
,
groupDN (string):
The distinguished name of the LDAP group. Applicable only if selectGroupMembers is true, ignored otherwise
,
groupMemberAttr (string):
The name of the LDAP group entry attribute which corresponds to distinguished names of members. Applicable only if selectGroupMembers is true, ignored otherwise
,
searchBaseDN (string):
The distinguished name of the element from which the LDAP server will search for users. Applicable only if selectGroupMembers is false, ignored otherwise
,
searchFilter (string):
The LDAP search filter used to select users if selectGroupMembers is false, may be left blank
,
searchScopeSubtree (boolean):
Whether to search for users in the entire subtree of the base DN or to only search one level under the base DN (if false). Applicable only if selectGroupMembers is false, ignored otherwise
,
selectGroupMembers (boolean):
Whether to sync using a group DN and member attribute selection or to use a search filter (if false)
Set options for syncing members of a team.
Enabling sync of team members will disable the ability to manually manage team
membership for any users imported from LDAP. Their team membership is instead
managed by the LDAP sync.
Requires authentication and authorization as an admin user, an admin member of
the organization, or an admin member of the team.
Whether to enable LDAP syncing. If false, all other fields are ignored
,
groupDN (string):
The distinguished name of the LDAP group. Applicable only if selectGroupMembers is true, ignored otherwise
,
groupMemberAttr (string):
The name of the LDAP group entry attribute which corresponds to distinguished names of members. Applicable only if selectGroupMembers is true, ignored otherwise
,
searchBaseDN (string):
The distinguished name of the element from which the LDAP server will search for users. Applicable only if selectGroupMembers is false, ignored otherwise
,
searchFilter (string):
The LDAP search filter used to select users if selectGroupMembers is false, may be left blank
,
searchScopeSubtree (boolean):
Whether to search for users in the entire subtree of the base DN or to only search one level under the base DN (if false). Applicable only if selectGroupMembers is false, ignored otherwise
,
selectGroupMembers (boolean):
Whether to sync using a group DN and member attribute selection or to use a search filter (if false)
List members of a team.
Lists memberships in ascending order by user ID.
Requires authentication and authorization as an admin user or a member of the
organization.
Remove a member from a team.
The user will remain a member of the organization. If team members are
configured to be synced with LDAP, users which are imported from LDAP cannot be
manually removed as members of the team and must be synced with LDAP.
Requires authentication and authorization as an admin user, an admin member of
the organization, or an admin member of the team.
Add a user to a team.
The user will be added as a member of the organization if they are not already.
If team members are configured to be synced with LDAP, users which are imported
from LDAP cannot be manually added as members of the team and must be synced
with LDAP.
Requires authentication and authorization as an admin user, an admin member of
the organization, or an admin member of the team.
List a user's organization memberships.
Lists organization memberships in ascending order by organization ID.
Requires authentication and authorization as an admin user or the target user.
If you create a UCP config with a name that starts with com.docker.ucp.config, UCP verifies that the config is valid before saving it. Also, UCP validates any licenses with names that start with com.docker.license.
The name of the image used when creating this container
,
ImageID (string, optional):
The ID of the image that this container was created from
,
Labels (object, optional):
User-defined key/value metadata.
,
Mounts (Array[Mount], optional),
Names (Array[string], optional):
The names that this container has been given
,
NetworkSettings (Inline Model 3, optional):
A summary of the container's network settings
,
Ports (Array[Port], optional):
The ports exposed by this container
,
SizeRootFs (integer, optional):
The total size of all the files in this container
,
SizeRw (integer, optional):
The size of files that have been created or changed by this container
,
State (string, optional):
The state of this container (e.g. Exited)
,
Status (string, optional):
Additional human-readable status of this container (e.g. Exit 0)
} Inline Model 2 {
NetworkMode (string, optional)
} Mount {
BindOptions (Inline Model 4, optional):
Optional configuration for the bind type.
,
Consistency (string, optional):
The consistency requirement for the mount: default, consistent, cached, or delegated.
,
ReadOnly (boolean, optional):
Whether the mount should be read-only.
,
Source (string, optional):
Mount source (e.g. a volume name, a host path).
,
Target (string, optional):
Container path.
,
TmpfsOptions (Inline Model 5, optional):
Optional configuration for the tmpfs type.
,
Type (string, optional):
The mount type. Available types:
bind Mounts a file or directory from the host into the container. Must exist prior to creating the container.
volume Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are not removed when the container is removed.
tmpfs Create a tmpfs with the given options. The mount source cannot be specified for tmpfs.
= ['bind', 'volume', 'tmpfs']
string
Enum:
"bind", "volume", "tmpfs"
,
VolumeOptions (Inline Model 6, optional):
Optional configuration for the volume type.
} Inline Model 3 {
Networks (object, optional)
} Port {
IP (string, optional),
PrivatePort (integer):
Port on the container
,
PublicPort (integer, optional):
Port exposed on the host
,
Type (string) = ['tcp', 'udp']
string
Enum:
"tcp", "udp"
} Inline Model 4 {
Propagation (object, optional):
A propagation mode with the value [r]private, [r]shared, or [r]slave.
A response header X-Docker-Container-Path-Stat is return containing a base64 - encoded JSON object with some filesystem header information about the path.
Attach to a container to read its output or send it input. You can attach to the same container multiple times and you can reattach to containers that have been detached.
Either the stream or logs parameter must be true for this endpoint to do anything.
When the TTY setting is disabled in POST /containers/create, the stream over the hijacked connected is multiplexed to separate out stdout and stderr. The stream consists of a series of frames, each containing a header and a payload.
The header contains the information which the stream writes (stdout or stderr). It also contains the size of the associated frame encoded in the last four bytes (uint32).
SIZE1, SIZE2, SIZE3, SIZE4 are the four bytes of the uint32 size encoded as big endian.
Following the header is the payload, which is the specified number of bytes of STREAM_TYPE.
The simplest way to implement this protocol is the following:
Read 8 bytes.
Choose stdout or stderr depending on the first byte.
Extract the frame size from the last four bytes.
Read the extracted size and output it on the correct output.
Goto 1.
Stream format when using a TTY
When the TTY setting is enabled in POST /containers/create, the stream is not multiplexed. The data exchanged over the hijacked connection is simply the raw data from the process PTY and client's stdin.
The total size of all the files in this container.
,
SizeRw (integer, optional):
The size of files that have been created or changed by this container.
,
State (Inline Model 1, optional):
The state of the container.
} ContainerConfig {
ArgsEscaped (boolean, optional):
Command is already escaped (Windows only)
,
AttachStderr (boolean, optional):
Whether to attach to stderr.
boolean
Default:
true
,
AttachStdin (boolean, optional):
Whether to attach to stdin.
boolean
Default:
false
,
AttachStdout (boolean, optional):
Whether to attach to stdout.
boolean
Default:
true
,
Cmd (array,string, optional):
Command to run specified as a string or an array of strings.
,
Domainname (string, optional):
The domain name to use for the container.
,
Entrypoint (array,string, optional):
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).
,
Env (Array[string], optional):
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.
,
ExposedPorts (object, optional):
An object mapping ports to an empty object in the form:
{"<port>/<tcp|udp>": {}}
,
Healthcheck (HealthConfig, optional),
Hostname (string, optional):
The hostname to use for the container, as a valid RFC 1123 hostname.
,
Image (string, optional):
The name of the image to use when creating the container
,
Labels (object, optional):
User-defined key/value metadata.
,
MacAddress (string, optional):
MAC address of the container.
,
NetworkDisabled (boolean, optional):
Disable networking for the container.
,
OnBuild (Array[string], optional):
ONBUILD metadata that were defined in the image's Dockerfile.
,
OpenStdin (boolean, optional):
Open stdin
boolean
Default:
false
,
Shell (Array[string], optional):
Shell for when RUN, CMD, and ENTRYPOINT uses a shell.
,
StdinOnce (boolean, optional):
Close stdin after one attached client disconnects
boolean
Default:
false
,
StopSignal (string, optional):
Signal to stop a container as a string or unsigned integer.
string
Default:
SIGTERM
,
StopTimeout (integer, optional):
Timeout to stop a container in seconds.
integer
Default:
10
,
Tty (boolean, optional):
Attach standard streams to a TTY, including stdin if it is not closed.
boolean
Default:
false
,
User (string, optional):
The user that commands are run as inside the container.
,
Volumes (Inline Model 2, optional):
An object mapping mount point paths inside the container to empty objects.
Limit write rate (IO per second) to a device, in the form [{"Path": "device_path", "Rate": rate}].
,
BlkioWeight (integer, optional):
Block IO weight (relative weight).
integer
Max. Value:
1000
,
BlkioWeightDevice (Array[Inline Model 3], optional):
Block IO weight (relative device weight) in the form [{"Path": "device_path", "Weight": weight}].
,
CgroupParent (string, optional):
Path to cgroups under which the container's cgroup is created. If the path is not absolute, the path is considered to be relative to the cgroups path of the init process. Cgroups are created if they do not already exist.
,
CpuCount (integer, optional):
The number of usable CPUs (Windows only).
On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is CPUCount first, then CPUShares, and CPUPercent last.
,
CpuPercent (integer, optional):
The usable percentage of the available CPUs (Windows only).
On Windows Server containers, the processor resource controls are mutually exclusive. The order of precedence is CPUCount first, then CPUShares, and CPUPercent last.
,
CpuPeriod (integer, optional):
The length of a CPU period in microseconds.
,
CpuQuota (integer, optional):
Microseconds of CPU time that the container can get in a CPU period.
,
CpuRealtimePeriod (integer, optional):
The length of a CPU real-time period in microseconds. Set to 0 to allocate no time allocated to real-time tasks.
,
CpuRealtimeRuntime (integer, optional):
The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no time allocated to real-time tasks.
,
CpuShares (integer, optional):
An integer value representing this container's relative CPU weight versus other containers.
,
CpusetCpus (string, optional):
CPUs in which to allow execution (e.g., 0-3, 0,1)
,
CpusetMems (string, optional):
Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.
,
DeviceCgroupRules (Array[string], optional):
a list of cgroup rules to apply to the container
,
Devices (Array[DeviceMapping], optional):
A list of devices to add to the container.
,
DiskQuota (integer, optional):
Disk limit (in bytes).
,
IOMaximumBandwidth (integer, optional):
Maximum IO in bytes per second for the container system drive (Windows only)
,
IOMaximumIOps (integer, optional):
Maximum IOps for the container system drive (Windows only)
,
KernelMemory (integer, optional):
Kernel memory limit in bytes.
,
Memory (integer, optional):
Memory limit in bytes.
integer
Default:
0
,
MemoryReservation (integer, optional):
Memory soft limit in bytes.
,
MemorySwap (integer, optional):
Total memory limit (memory + swap). Set as -1 to enable unlimited swap.
,
MemorySwappiness (integer, optional):
Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.
integer
Max. Value:
100
,
NanoCPUs (integer, optional):
CPU quota in units of 10-9 CPUs.
,
OomKillDisable (boolean, optional):
Disable OOM Killer for the container.
,
PidsLimit (integer, optional):
Tune a container's pids limit. Set -1 for unlimited.
,
Ulimits (Array[Inline Model 4], optional):
A list of resource limits to set in the container. For example: {"Name": "nofile", "Soft": 1024, "Hard": 2048}"
,
AutoRemove (boolean, optional):
Automatically remove the container when the container's process exits. This has no effect if RestartPolicy is set.
,
Binds (Array[string], optional):
A list of volume bindings for this container. Each volume binding is a string in one of these forms:
host-src:container-dest to bind-mount a host path into the container. Both host-src, and container-dest must be an absolute path.
host-src:container-dest:ro to make the bind-mount read-only inside the container. Both host-src, and container-dest must be an absolute path.
volume-name:container-dest to bind-mount a volume managed by a volume driver into the container. container-dest must be an absolute path.
volume-name:container-dest:ro to mount the volume read-only inside the container. container-dest must be an absolute path.
,
CapAdd (Array[string], optional):
A list of kernel capabilities to add to the container.
,
CapDrop (Array[string], optional):
A list of kernel capabilities to drop from the container.
,
Cgroup (string, optional):
Cgroup to use for the container.
,
ConsoleSize (Array[integer], optional):
Initial console size, as an [height, width] array. (Windows only)
integer
Min. Items:
2
Max. Items:
2
,
ContainerIDFile (string, optional):
Path to a file where the container ID is written
,
Dns (Array[string], optional):
A list of DNS servers for the container to use.
,
DnsOptions (Array[string], optional):
A list of DNS options.
,
DnsSearch (Array[string], optional):
A list of DNS search domains.
,
ExtraHosts (Array[string], optional):
A list of hostnames/IP mappings to add to the container's /etc/hosts file. Specified in the form ["hostname:IP"].
,
GroupAdd (Array[string], optional):
A list of additional groups that the container process will run as.
,
IpcMode (string, optional):
IPC namespace to use for the container.
,
Isolation (string, optional):
Isolation technology of the container. (Windows only)
= ['default', 'process', 'hyperv']
string
Enum:
"default", "process", "hyperv"
,
Links (Array[string], optional):
A list of links for the container in the form container_name:alias.
,
LogConfig (Inline Model 5, optional):
The logging configuration for this container
,
Mounts (Array[Mount], optional):
Specification for mounts to be added to the container.
,
NetworkMode (string, optional):
Network mode to use for this container. Supported standard values are: bridge, host, none, and container:<name|id>. Any other value is taken as a custom network's name to which this container should connect to.
,
OomScoreAdj (integer, optional):
An integer value containing the score given to the container in order to tune OOM killer preferences.
,
PidMode (string, optional):
Set the PID (Process) Namespace mode for the container. It can be either:
"container:<name|id>": joins another container's PID namespace
"host": use the host's PID namespace inside the container
,
PortBindings (object, optional):
A map of exposed container ports and the host port they should map to.
,
Privileged (boolean, optional):
Gives the container full access to the host.
,
PublishAllPorts (boolean, optional):
Allocates a random host port for all of a container's exposed ports.
,
ReadonlyRootfs (boolean, optional):
Mount the container's root filesystem as read only.
,
RestartPolicy (RestartPolicy, optional),
Runtime (string, optional):
Runtime to use with this container.
,
SecurityOpt (Array[string], optional):
A list of string values to customize labels for MLS systems, such as SELinux.
,
ShmSize (integer, optional):
Size of /dev/shm in bytes. If omitted, the system uses 64MB.
,
StorageOpt (object, optional):
Storage driver options for this container, in the form {"size": "120G"}.
,
Sysctls (object, optional):
A list of kernel parameters (sysctls) to set in the container. For example: {"net.ipv4.ip_forward": "1"}
,
Tmpfs (object, optional):
A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options. For example: { "/run": "rw,noexec,nosuid,size=65536k" }.
,
UTSMode (string, optional):
UTS namespace to use for the container.
,
UsernsMode (string, optional):
Sets the usernamespace mode for the container when usernamespace remapping option is enabled.
,
VolumeDriver (string, optional):
Driver that this container uses to mount volumes.
,
VolumesFrom (Array[string], optional):
A list of volumes to inherit from another container, specified in the form <container name="">[:<ro|rw>].
} MountPoint {
Destination (string, optional),
Driver (string, optional),
Mode (string, optional),
Name (string, optional),
Propagation (string, optional),
RW (boolean, optional),
Source (string, optional),
Type (string, optional)
} NetworkConfig {
Address (string, optional),
Bridge (string, optional),
Gateway (string, optional),
IPPrefixLen (integer, optional),
MacAddress (string, optional),
PortMapping (string, optional),
Ports (Array[Port], optional)
} Inline Model 1 {
Dead (boolean, optional),
Error (string, optional),
ExitCode (integer, optional):
The last exit code of this container
,
FinishedAt (string, optional):
The time when this container last exited.
,
OOMKilled (boolean, optional):
Whether this container has been killed because it ran out of memory.
,
Paused (boolean, optional):
Whether this container is paused.
,
Pid (integer, optional):
The process ID of this container
,
Restarting (boolean, optional):
Whether this container is restarting.
,
Running (boolean, optional):
Whether this container is running.
Note that a running container can be paused. The Running and Paused
booleans are not mutually exclusive:
When pausing a container (on Linux), the cgroups freezer is used to suspend
all processes in the container. Freezing the process requires the process to
be running. As a result, paused containers are both RunningandPaused.
Use the Status field instead to determine if a container's state is "running".
,
StartedAt (string, optional):
The time when this container was last started.
,
Status (string, optional):
The status of the container. For example, "running" or "exited".
The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
,
Retries (integer, optional):
The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit.
,
StartPeriod (integer, optional):
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.
,
Test (Array[string], optional):
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
,
Timeout (integer, optional):
The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
The consistency requirement for the mount: default, consistent, cached, or delegated.
,
ReadOnly (boolean, optional):
Whether the mount should be read-only.
,
Source (string, optional):
Mount source (e.g. a volume name, a host path).
,
Target (string, optional):
Container path.
,
TmpfsOptions (Inline Model 7, optional):
Optional configuration for the tmpfs type.
,
Type (string, optional):
The mount type. Available types:
bind Mounts a file or directory from the host into the container. Must exist prior to creating the container.
volume Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are not removed when the container is removed.
tmpfs Create a tmpfs with the given options. The mount source cannot be specified for tmpfs.
= ['bind', 'volume', 'tmpfs']
string
Enum:
"bind", "volume", "tmpfs"
,
VolumeOptions (Inline Model 8, optional):
Optional configuration for the volume type.
} RestartPolicy {
MaximumRetryCount (integer, optional):
If on-failure is used, the number of times to retry before giving up
,
Name (string, optional):
Empty string means not to restart
always Always restart
unless-stopped Restart always except when the user has manually stopped the container
on-failure Restart only when the container exit code is non-zero
= ['', 'always', 'unless-stopped', 'on-failure']
string
Enum:
"", "always", "unless-stopped", "on-failure"
} Port {
IP (string, optional),
PrivatePort (integer):
Port on the container
,
PublicPort (integer, optional):
Port exposed on the host
,
Type (string) = ['tcp', 'udp']
string
Enum:
"tcp", "udp"
} Inline Model 6 {
Propagation (object, optional):
A propagation mode with the value [r]private, [r]shared, or [r]slave.
Use the cgroups freezer to suspend all processes in a container.
Traditionally, when suspending a process the SIGSTOP signal is used, which is observable by the process being suspended. With the cgroups freezer the process is unaware, and unable to capture, that it is being suspended, and subsequently resumed.
This endpoint returns a live stream of a container’s resource usage
statistics.
The precpu_stats is the CPU statistic of last read, which is used
for calculating the CPU usage percentage. It is not the same as the
cpu_stats field.
If either precpu_stats.online_cpus or cpu_stats.online_cpus is
nil then for compatibility with older daemons the length of the
corresponding cpu_usage.percpu_usage array should be used.
Exec : Run new commands inside running containers. See the [command-line reference](https://docs.docker.com/engine/reference/commandline/exec/) for more information.
To exec a command in a container, you first need to create an exec instance, then start it. These two API endpoints are wrapped up in a single command-line command, `docker exec`.
Starts a previously set up exec instance. If detach is true, this endpoint returns immediately after starting the command. Otherwise, it sets up an interactive session with the command.
Build an image from a tar archive with a Dockerfile in it.
The Dockerfile specifies how the image is built from the tar archive. It is typically in the archive's root, but can be at a different path or have a different name by specifying the dockerfile parameter. See the Dockerfile reference for more information.
The Docker daemon performs a preliminary validation of the Dockerfile before starting the build, and returns an error if the syntax is incorrect. After that, each instruction is run one-by-one until the ID of the new image is output.
The build is canceled if the client drops the connection by quitting or being killed.
Create an image by either pulling it from a registry or importing it.
The create request pulls the image onto every node in the swarm that exists at that time and that have the right operating system. Nodes that join the swarm later or that don't have the same base OS as the image won't get the image.
Get a tarball containing all images and metadata for several image repositories.
For each value of the names parameter: if it is a specific name and tag (e.g. ubuntu:latest), then only that image (and its parents) are returned; if it is an image ID, similarly only that image (and its parents) are returned and there would be no names referenced in the 'repositories' file for this image ID.
The image is loaded on all nodes in the swarm that are compatible with the image's architecture. For example, Windows images aren't loaded on Linux nodes, and vice-versa.
Get a tarball containing all images and metadata for a repository.
If name is a specific name and tag (e.g. ubuntu:latest), then only that image (and its parents) are returned. If name is an image ID, similarly only that image (and its parents) are returned, but with the exclusion of the repositories file in the tarball, as there were no image names referenced.
Image tarball format
An image tarball contains one directory per image layer (named using its long ID), each containing these files:
VERSION: currently 1.0 - the file format version
json: detailed layer information, similar to docker inspect layer_id
layer.tar: A tarfile containing the filesystem changes in this layer
The layer.tar file contains aufs style .wh..wh.aufs files and directories for storing attribute changes and deletions.
If the tarball defines a repository, the tarball should also include a repositories file at the root that contains a list of repository and tag names mapped to layer IDs.
Command to run specified as a string or an array of strings.
,
Domainname (string, optional):
The domain name to use for the container.
,
Entrypoint (array,string, optional):
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).
,
Env (Array[string], optional):
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.
,
ExposedPorts (object, optional):
An object mapping ports to an empty object in the form:
{"<port>/<tcp|udp>": {}}
,
Healthcheck (HealthConfig, optional),
Hostname (string, optional):
The hostname to use for the container, as a valid RFC 1123 hostname.
,
Image (string, optional):
The name of the image to use when creating the container
,
Labels (object, optional):
User-defined key/value metadata.
,
MacAddress (string, optional):
MAC address of the container.
,
NetworkDisabled (boolean, optional):
Disable networking for the container.
,
OnBuild (Array[string], optional):
ONBUILD metadata that were defined in the image's Dockerfile.
,
OpenStdin (boolean, optional):
Open stdin
boolean
Default:
false
,
Shell (Array[string], optional):
Shell for when RUN, CMD, and ENTRYPOINT uses a shell.
,
StdinOnce (boolean, optional):
Close stdin after one attached client disconnects
boolean
Default:
false
,
StopSignal (string, optional):
Signal to stop a container as a string or unsigned integer.
string
Default:
SIGTERM
,
StopTimeout (integer, optional):
Timeout to stop a container in seconds.
integer
Default:
10
,
Tty (boolean, optional):
Attach standard streams to a TTY, including stdin if it is not closed.
boolean
Default:
false
,
User (string, optional):
The user that commands are run as inside the container.
,
Volumes (Inline Model 2, optional):
An object mapping mount point paths inside the container to empty objects.
,
WorkingDir (string, optional):
The working directory for commands to run in.
} GraphDriverData {
Data (object),
Name (string)
} Inline Model 1 {
BaseLayer (string, optional),
Layers (Array[string], optional),
Type (string)
} HealthConfig {
Interval (integer, optional):
The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
,
Retries (integer, optional):
The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit.
,
StartPeriod (integer, optional):
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.
,
Test (Array[string], optional):
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
,
Timeout (integer, optional):
The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
If you wish to push an image on to a private registry, that image must already have a tag which references the registry. For example, registry.example.com/myimage:latest.
The push is cancelled if the HTTP connection is closed.
Tag an image so that it becomes part of a repository.
Curl
Request URL
Response Body
Response Code
Response Headers
Network : Networks are user-defined networks that containers can be attached to. See the [networking documentation](https://docs.docker.com/engine/userguide/networking/) for more information.
Note that it uses a different, smaller representation of a network than inspecting a single network. For example,
the list of containers attached to the network is not propagated in API versions 1.28 and up.
Node-specific networks, like those with bridge and third-party drivers, are prefixed with the node name.
List of IPAM configuration options, specified as a map: {"Subnet": <cidr>, "IPRange": <cidr>, "Gateway": <ip address="">, "AuxAddress": <device_name:ip address="">}
If the name is prefixed with the name of a node, the create request is sent to the specified node. Use the '/' character to separate the node name, like testnode/testnet.
List of IPAM configuration options, specified as a map: {"Subnet": <cidr>, "IPRange": <cidr>, "Gateway": <ip address="">, "AuxAddress": <device_name:ip address="">}
Configuration for forwarding signing requests to an external certificate authority.
,
ForceRotate (object, optional):
An integer whose purpose is to force swarm to generate a new signing CA certificate and key, if none have been specified in SigningCACert and SigningCAKey
,
NodeCertExpiry (integer, optional):
The duration node certificates are issued for.
,
SigningCACert (string, optional):
The desired signing CA certificate for all swarm node TLS leaf certificates, in PEM format.
,
SigningCAKey (string, optional):
The desired signing CA key for all swarm node TLS leaf certificates, in PEM format.
} Inline Model 7 {
HeartbeatPeriod (integer, optional):
The delay for an agent to send a heartbeat to the dispatcher.
} Inline Model 8 {
AutoLockManagers (boolean, optional):
If set, generate a key and use it to lock data stored on the managers.
} Inline Model 9 {
TaskHistoryRetentionLimit (integer, optional):
The number of historic tasks to keep per instance or node. If negative, never remove completed or failed tasks.
} Inline Model 10 {
ElectionTick (integer, optional):
The number of ticks that a follower will wait for a message from the leader before becoming a candidate and starting an election. ElectionTick must be greater than HeartbeatTick.
A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed.
,
HeartbeatTick (integer, optional):
The number of ticks between heartbeats. Every HeartbeatTick ticks, the leader will send a heartbeat to the followers.
A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed.
,
KeepOldSnapshots (integer, optional):
The number of snapshots to keep beyond the current snapshot.
,
LogEntriesForSlowFollowers (integer, optional):
The number of log entries to keep around to sync up slow followers after a snapshot is created.
,
SnapshotInterval (integer, optional):
The number of log entries between snapshots.
} Inline Model 11 {
LogDriver (Inline Model 13, optional):
The log driver to use for tasks created in the orchestrator if unspecified by a service.
Updating this value will only have an affect on new tasks. Old tasks will continue use their previously configured log driver until recreated.
} Inline Model 12 {
CACert (string, optional):
The root CA certificate (in PEM format) this external CA uses to issue TLS certificates (assumed to be to the current swarm root CA certificate if not provided).
,
Options (object, optional):
An object with key/value pairs that are interpreted as protocol-specific options for the external CA driver.
,
Protocol (string, optional):
Protocol for communication with the external CA (currently only cfssl is supported).
= ['cfssl']
string
Default:
cfssl
Enum:
"cfssl"
,
URL (string, optional):
URL where certificate signing requests should be sent.
Configuration for forwarding signing requests to an external certificate authority.
,
ForceRotate (object, optional):
An integer whose purpose is to force swarm to generate a new signing CA certificate and key, if none have been specified in SigningCACert and SigningCAKey
,
NodeCertExpiry (integer, optional):
The duration node certificates are issued for.
,
SigningCACert (string, optional):
The desired signing CA certificate for all swarm node TLS leaf certificates, in PEM format.
,
SigningCAKey (string, optional):
The desired signing CA key for all swarm node TLS leaf certificates, in PEM format.
} Inline Model 7 {
HeartbeatPeriod (integer, optional):
The delay for an agent to send a heartbeat to the dispatcher.
} Inline Model 8 {
AutoLockManagers (boolean, optional):
If set, generate a key and use it to lock data stored on the managers.
} Inline Model 9 {
TaskHistoryRetentionLimit (integer, optional):
The number of historic tasks to keep per instance or node. If negative, never remove completed or failed tasks.
} Inline Model 10 {
ElectionTick (integer, optional):
The number of ticks that a follower will wait for a message from the leader before becoming a candidate and starting an election. ElectionTick must be greater than HeartbeatTick.
A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed.
,
HeartbeatTick (integer, optional):
The number of ticks between heartbeats. Every HeartbeatTick ticks, the leader will send a heartbeat to the followers.
A tick currently defaults to one second, so these translate directly to seconds currently, but this is NOT guaranteed.
,
KeepOldSnapshots (integer, optional):
The number of snapshots to keep beyond the current snapshot.
,
LogEntriesForSlowFollowers (integer, optional):
The number of log entries to keep around to sync up slow followers after a snapshot is created.
,
SnapshotInterval (integer, optional):
The number of log entries between snapshots.
} Inline Model 11 {
LogDriver (Inline Model 13, optional):
The log driver to use for tasks created in the orchestrator if unspecified by a service.
Updating this value will only have an affect on new tasks. Old tasks will continue use their previously configured log driver until recreated.
} Inline Model 12 {
CACert (string, optional):
The root CA certificate (in PEM format) this external CA uses to issue TLS certificates (assumed to be to the current swarm root CA certificate if not provided).
,
Options (object, optional):
An object with key/value pairs that are interpreted as protocol-specific options for the external CA driver.
,
Protocol (string, optional):
Protocol for communication with the external CA (currently only cfssl is supported).
= ['cfssl']
string
Default:
cfssl
Enum:
"cfssl"
,
URL (string, optional):
URL where certificate signing requests should be sent.
Get options for syncing admin members of an organization.
Requires authentication and authorization as an admin user or an admin member
of the organization.
Whether to enable LDAP syncing. If false, all other fields are ignored
,
groupDN (string):
The distinguished name of the LDAP group. Applicable only if selectGroupMembers is true, ignored otherwise
,
groupMemberAttr (string):
The name of the LDAP group entry attribute which corresponds to distinguished names of members. Applicable only if selectGroupMembers is true, ignored otherwise
,
searchBaseDN (string):
The distinguished name of the element from which the LDAP server will search for users. Applicable only if selectGroupMembers is false, ignored otherwise
,
searchFilter (string):
The LDAP search filter used to select users if selectGroupMembers is false, may be left blank
,
searchScopeSubtree (boolean):
Whether to search for users in the entire subtree of the base DN or to only search one level under the base DN (if false). Applicable only if selectGroupMembers is false, ignored otherwise
,
selectGroupMembers (boolean):
Whether to sync using a group DN and member attribute selection or to use a search filter (if false)
Set options for syncing admin members of an organization.
Enabling sync of organization admin members will disable the ability to
directly manage organization membership for any users imported from an LDAP
directory. Their organization membership is instead set by being synced as an
admin member of the organization or by being a member of any team within the
organization.
Requires authentication and authorization as an admin user or an admin member
of the organization.
Whether to enable LDAP syncing. If false, all other fields are ignored
,
groupDN (string):
The distinguished name of the LDAP group. Applicable only if selectGroupMembers is true, ignored otherwise
,
groupMemberAttr (string):
The name of the LDAP group entry attribute which corresponds to distinguished names of members. Applicable only if selectGroupMembers is true, ignored otherwise
,
searchBaseDN (string):
The distinguished name of the element from which the LDAP server will search for users. Applicable only if selectGroupMembers is false, ignored otherwise
,
searchFilter (string):
The LDAP search filter used to select users if selectGroupMembers is false, may be left blank
,
searchScopeSubtree (boolean):
Whether to search for users in the entire subtree of the base DN or to only search one level under the base DN (if false). Applicable only if selectGroupMembers is false, ignored otherwise
,
selectGroupMembers (boolean):
Whether to sync using a group DN and member attribute selection or to use a search filter (if false)
List members of an organization.
Lists memberships in ascending order by user ID.
Requires authentication and authorization as an admin user or a member of the
organization.
Remove a user from an organization.
Removing a member of the organization will also remove them from any teams in
the organization. If organization admin members are configured to be synced
with LDAP, users which are imported from LDAP cannot be manually removed as
members of the organization and must be either synced as an organization admin
member or removed as a member of all teams within the organization.
Requires authentication and authorization as an admin user or an admin member
of the organization.
Details of a user's membership in an organization.
Requires authentication and authorization as an admin user, a member of the
organization, or the target user.
Add a user to an organization.
If organization admin members are configured to be synced with LDAP, users
which are imported from LDAP cannot be manually added as members of the
organization and must be either synced as an organization admin member or be
added as a member of team within the organization.
Requires authentication and authorization as an admin user or an admin member
of the organization
List a user's team membership in an organization.
Lists team memberships in ascending order by team ID.
Requires authentication and authorization as an admin user or a member of the
organization.
Get options for syncing admin members of an organization.
Requires authentication and authorization as an admin user or an admin member
of the organization.
Whether to enable LDAP syncing. If false, all other fields are ignored
,
groupDN (string):
The distinguished name of the LDAP group. Applicable only if selectGroupMembers is true, ignored otherwise
,
groupMemberAttr (string):
The name of the LDAP group entry attribute which corresponds to distinguished names of members. Applicable only if selectGroupMembers is true, ignored otherwise
,
searchBaseDN (string):
The distinguished name of the element from which the LDAP server will search for users. Applicable only if selectGroupMembers is false, ignored otherwise
,
searchFilter (string):
The LDAP search filter used to select users if selectGroupMembers is false, may be left blank
,
searchScopeSubtree (boolean):
Whether to search for users in the entire subtree of the base DN or to only search one level under the base DN (if false). Applicable only if selectGroupMembers is false, ignored otherwise
,
selectGroupMembers (boolean):
Whether to sync using a group DN and member attribute selection or to use a search filter (if false)
Set options for syncing admin members of an organization.
Enabling sync of organization admin members will disable the ability to
directly manage organization membership for any users imported from an LDAP
directory. Their organization membership is instead set by being synced as an
admin member of the organization or by being a member of any team within the
organization.
Requires authentication and authorization as an admin user or an admin member
of the organization.
Whether to enable LDAP syncing. If false, all other fields are ignored
,
groupDN (string):
The distinguished name of the LDAP group. Applicable only if selectGroupMembers is true, ignored otherwise
,
groupMemberAttr (string):
The name of the LDAP group entry attribute which corresponds to distinguished names of members. Applicable only if selectGroupMembers is true, ignored otherwise
,
searchBaseDN (string):
The distinguished name of the element from which the LDAP server will search for users. Applicable only if selectGroupMembers is false, ignored otherwise
,
searchFilter (string):
The LDAP search filter used to select users if selectGroupMembers is false, may be left blank
,
searchScopeSubtree (boolean):
Whether to search for users in the entire subtree of the base DN or to only search one level under the base DN (if false). Applicable only if selectGroupMembers is false, ignored otherwise
,
selectGroupMembers (boolean):
Whether to sync using a group DN and member attribute selection or to use a search filter (if false)
List members of an organization.
Lists memberships in ascending order by user ID.
Requires authentication and authorization as an admin user or a member of the
organization.
Remove a user from an organization.
Removing a member of the organization will also remove them from any teams in
the organization. If organization admin members are configured to be synced
with LDAP, users which are imported from LDAP cannot be manually removed as
members of the organization and must be either synced as an organization admin
member or removed as a member of all teams within the organization.
Requires authentication and authorization as an admin user or an admin member
of the organization.
Details of a user's membership in an organization.
Requires authentication and authorization as an admin user, a member of the
organization, or the target user.
Add a user to an organization.
If organization admin members are configured to be synced with LDAP, users
which are imported from LDAP cannot be manually added as members of the
organization and must be either synced as an organization admin member or be
added as a member of team within the organization.
Requires authentication and authorization as an admin user or an admin member
of the organization
List a user's team membership in an organization.
Lists team memberships in ascending order by team ID.
Requires authentication and authorization as an admin user or a member of the
organization.
List teams in an organization.
Lists teams in ascending order by name.
Requires authentication and authorization as an admin user or a member of the
organization.
Update details for a team.
Requires authentication and authorization as an admin user, an admin member of
the organization, or an admin member of the team.
Get options for syncing members of a team.
Requires authentication and authorization as an admin user, an admin member of
the organization, or an admin member of the team.
Whether to enable LDAP syncing. If false, all other fields are ignored
,
groupDN (string):
The distinguished name of the LDAP group. Applicable only if selectGroupMembers is true, ignored otherwise
,
groupMemberAttr (string):
The name of the LDAP group entry attribute which corresponds to distinguished names of members. Applicable only if selectGroupMembers is true, ignored otherwise
,
searchBaseDN (string):
The distinguished name of the element from which the LDAP server will search for users. Applicable only if selectGroupMembers is false, ignored otherwise
,
searchFilter (string):
The LDAP search filter used to select users if selectGroupMembers is false, may be left blank
,
searchScopeSubtree (boolean):
Whether to search for users in the entire subtree of the base DN or to only search one level under the base DN (if false). Applicable only if selectGroupMembers is false, ignored otherwise
,
selectGroupMembers (boolean):
Whether to sync using a group DN and member attribute selection or to use a search filter (if false)
Set options for syncing members of a team.
Enabling sync of team members will disable the ability to manually manage team
membership for any users imported from LDAP. Their team membership is instead
managed by the LDAP sync.
Requires authentication and authorization as an admin user, an admin member of
the organization, or an admin member of the team.
Whether to enable LDAP syncing. If false, all other fields are ignored
,
groupDN (string):
The distinguished name of the LDAP group. Applicable only if selectGroupMembers is true, ignored otherwise
,
groupMemberAttr (string):
The name of the LDAP group entry attribute which corresponds to distinguished names of members. Applicable only if selectGroupMembers is true, ignored otherwise
,
searchBaseDN (string):
The distinguished name of the element from which the LDAP server will search for users. Applicable only if selectGroupMembers is false, ignored otherwise
,
searchFilter (string):
The LDAP search filter used to select users if selectGroupMembers is false, may be left blank
,
searchScopeSubtree (boolean):
Whether to search for users in the entire subtree of the base DN or to only search one level under the base DN (if false). Applicable only if selectGroupMembers is false, ignored otherwise
,
selectGroupMembers (boolean):
Whether to sync using a group DN and member attribute selection or to use a search filter (if false)
List members of a team.
Lists memberships in ascending order by user ID.
Requires authentication and authorization as an admin user or a member of the
organization.
Remove a member from a team.
The user will remain a member of the organization. If team members are
configured to be synced with LDAP, users which are imported from LDAP cannot be
manually removed as members of the team and must be synced with LDAP.
Requires authentication and authorization as an admin user, an admin member of
the organization, or an admin member of the team.
Add a user to a team.
The user will be added as a member of the organization if they are not already.
If team members are configured to be synced with LDAP, users which are imported
from LDAP cannot be manually added as members of the team and must be synced
with LDAP.
Requires authentication and authorization as an admin user, an admin member of
the organization, or an admin member of the team.
Array of network names or IDs to attach the service to.
,
RollbackConfig (Inline Model 6, optional):
Specification for the rollback strategy of the service.
,
TaskTemplate (TaskSpec, optional),
UpdateConfig (Inline Model 7, optional):
Specification for the update strategy of the service.
} Inline Model 2 {
CompletedAt (string, optional),
Message (string, optional),
StartedAt (string, optional),
State (string, optional) = ['updating', 'paused', 'completed']
string
Enum:
"updating", "paused", "completed"
} ObjectVersion {
Index (integer, optional)
} EndpointPortConfig {
Name (string, optional),
Protocol (string, optional) = ['tcp', 'udp']
string
Enum:
"tcp", "udp"
,
PublishedPort (integer, optional):
The port on the swarm hosts.
,
TargetPort (integer, optional):
The port inside the container.
} EndpointSpec {
Mode (string, optional):
The mode of resolution to use for internal load balancing between tasks.
= ['vip', 'dnsrr']
string
Default:
vip
Enum:
"vip", "dnsrr"
,
Ports (Array[EndpointPortConfig], optional):
List of exposed ports that this service is accessible on from the outside. Ports can only be provided if vip resolution mode is used.
} Inline Model 3 {
Addr (string, optional),
NetworkID (string, optional)
} Inline Model 4 {
Global (object, optional),
Replicated (Inline Model 8, optional)
} Inline Model 5 {
Aliases (Array[string], optional),
Target (string, optional)
} Inline Model 6 {
Delay (integer, optional):
Amount of time between rollback iterations, in nanoseconds.
,
FailureAction (string, optional):
Action to take if an rolled back task fails to run, or stops running during the rollback.
= ['continue', 'pause']
string
Enum:
"continue", "pause"
,
MaxFailureRatio (number, optional):
The fraction of tasks that may fail during a rollback before the failure action is invoked, specified as a floating point number between 0 and 1.
number
Default:
0
,
Monitor (integer, optional):
Amount of time to monitor each rolled back task for failures, in nanoseconds.
,
Order (string, optional):
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.
= ['stop-first', 'start-first']
string
Enum:
"stop-first", "start-first"
,
Parallelism (integer, optional):
Maximum number of tasks to be rolled back in one iteration (0 means unlimited parallelism).
} TaskSpec {
ContainerSpec (Inline Model 9, optional),
ForceUpdate (integer, optional):
A counter that triggers an update even if no relevant parameters have been changed.
,
LogDriver (Inline Model 10, optional):
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.
,
Networks (Array[Inline Model 11], optional),
Placement (Inline Model 12, optional),
Resources (Inline Model 13, optional):
Resource requirements which apply to each individual container created as part of the service.
,
RestartPolicy (Inline Model 14, optional):
Specification for the restart policy which applies to containers created as part of this service.
,
Runtime (string, optional):
Runtime is the type of runtime specified for the task executor.
} Inline Model 7 {
Delay (integer, optional):
Amount of time between updates, in nanoseconds.
,
FailureAction (string, optional):
Action to take if an updated task fails to run, or stops running during the update.
= ['continue', 'pause', 'rollback']
string
Enum:
"continue", "pause", "rollback"
,
MaxFailureRatio (number, optional):
The fraction of tasks that may fail during an update before the failure action is invoked, specified as a floating point number between 0 and 1.
number
Default:
0
,
Monitor (integer, optional):
Amount of time to monitor each updated task for failures, in nanoseconds.
,
Order (string, optional):
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.
= ['stop-first', 'start-first']
string
Enum:
"stop-first", "start-first"
,
Parallelism (integer, optional):
Maximum number of tasks to be updated in one iteration (0 means unlimited parallelism).
} Inline Model 8 {
Replicas (integer, optional)
} Inline Model 9 {
Args (Array[string], optional):
Arguments to the command.
,
Command (Array[string], optional):
The command to be run in the image.
,
Configs (Array[Inline Model 15], optional):
Configs contains references to zero or more configs that will be exposed to the service.
,
DNSConfig (Inline Model 16, optional):
Specification for DNS related configurations in resolver configuration file (resolv.conf).
,
Dir (string, optional):
The working directory for commands to run in.
,
Env (Array[string], optional):
A list of environment variables in the form VAR=value.
,
Groups (Array[string], optional):
A list of additional groups that the container process will run as.
,
HealthCheck (HealthConfig, optional),
Hostname (string, optional):
The hostname to use for the container, as a valid RFC 1123 hostname.
,
Hosts (Array[string], optional):
A list of hostnames/IP mappings to add to the container's /etc/hosts file.
The format of extra hosts on swarmkit is specified in:
http://man7.org/linux/man-pages/man5/hosts.5.html
IP_address canonical_hostname [aliases...]
,
Image (string, optional):
The image name to use for the container.
,
Labels (object, optional):
User-defined key/value data.
,
Mounts (Array[Mount], optional):
Specification for mounts to be added to containers created as part of the service.
,
OpenStdin (boolean, optional):
Open stdin
,
Privileges (Inline Model 17, optional):
Security options for the container
,
ReadOnly (boolean, optional):
Mount the container's root filesystem as read only.
,
Secrets (Array[Inline Model 18], optional):
Secrets contains references to zero or more secrets that will be exposed to the service.
,
StopGracePeriod (integer, optional):
Amount of time to wait for the container to terminate before forcefully killing it.
,
StopSignal (string, optional):
Signal to stop the container.
,
TTY (boolean, optional):
Whether a pseudo-TTY should be allocated.
,
User (string, optional):
The user inside the container.
} Inline Model 10 {
Name (string, optional),
Options (object, optional)
} Inline Model 11 {
Aliases (Array[string], optional),
Target (string, optional)
} Inline Model 12 {
Constraints (Array[string], optional):
An array of constraints.
,
Platforms (Array[Inline Model 19], optional):
An array of supported platforms.
,
Preferences (Array[Inline Model 20], optional):
Preferences provide a way to make the scheduler aware of factors such as topology. They are provided in order from highest to lowest precedence.
} Inline Model 13 {
Limits (Inline Model 21, optional):
Define resources limits.
,
Reservation (Inline Model 22, optional):
Define resources reservation.
} Inline Model 14 {
Condition (string, optional):
Condition for restart.
= ['none', 'on-failure', 'any']
string
Enum:
"none", "on-failure", "any"
,
Delay (integer, optional):
Delay between restart attempts.
,
MaxAttempts (integer, optional):
Maximum attempts to restart a given container before giving up (default value is 0, which is ignored).
integer
Default:
0
,
Window (integer, optional):
Windows is the time window used to evaluate the restart policy (default value is 0, which is unbounded).
integer
Default:
0
} Inline Model 15 {
ConfigID (string, optional):
ConfigID represents the ID of the specific config that we're referencing.
,
ConfigName (string, optional):
ConfigName is the name of the config that this references, but this is just provided for
lookup/display purposes. The config in the reference will be identified by its ID.
,
File (Inline Model 23, optional):
File represents a specific target that is backed by a file.
} Inline Model 16 {
Nameservers (Array[string], optional):
The IP addresses of the name servers.
,
Options (Array[string], optional):
A list of internal resolver variables to be modified (e.g., debug, ndots:3, etc.).
,
Search (Array[string], optional):
A search list for host-name lookup.
} HealthConfig {
Interval (integer, optional):
The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
,
Retries (integer, optional):
The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit.
,
StartPeriod (integer, optional):
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.
,
Test (Array[string], optional):
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
,
Timeout (integer, optional):
The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
} Mount {
BindOptions (Inline Model 24, optional):
Optional configuration for the bind type.
,
Consistency (string, optional):
The consistency requirement for the mount: default, consistent, cached, or delegated.
,
ReadOnly (boolean, optional):
Whether the mount should be read-only.
,
Source (string, optional):
Mount source (e.g. a volume name, a host path).
,
Target (string, optional):
Container path.
,
TmpfsOptions (Inline Model 25, optional):
Optional configuration for the tmpfs type.
,
Type (string, optional):
The mount type. Available types:
bind Mounts a file or directory from the host into the container. Must exist prior to creating the container.
volume Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are not removed when the container is removed.
tmpfs Create a tmpfs with the given options. The mount source cannot be specified for tmpfs.
= ['bind', 'volume', 'tmpfs']
string
Enum:
"bind", "volume", "tmpfs"
,
VolumeOptions (Inline Model 26, optional):
Optional configuration for the volume type.
} Inline Model 17 {
CredentialSpec (Inline Model 27, optional):
CredentialSpec for managed service account (Windows only)
,
SELinuxContext (Inline Model 28, optional):
SELinux labels of the container
} Inline Model 18 {
File (Inline Model 29, optional):
File represents a specific target that is backed by a file.
,
SecretID (string, optional):
SecretID represents the ID of the specific secret that we're referencing.
,
SecretName (string, optional):
SecretName is the name of the secret that this references, but this is just provided for
lookup/display purposes. The secret in the reference will be identified by its ID.
} Inline Model 19 {
Architecture (string, optional),
OS (string, optional)
} Inline Model 20 {
Spread (Inline Model 30, optional)
} Inline Model 21 {
MemoryBytes (integer, optional):
Memory limit in Bytes.
,
NanoCPUs (integer, optional):
CPU limit in units of 10-9 CPU shares.
} Inline Model 22 {
MemoryBytes (integer, optional):
Memory reservation in Bytes.
,
NanoCPUs (integer, optional):
CPU reservation in units of 10-9 CPU shares.
} Inline Model 23 {
GID (string, optional):
GID represents the file GID.
,
Mode (integer, optional):
Mode represents the FileMode of the file.
,
Name (string, optional):
Name represents the final filename in the filesystem.
,
UID (string, optional):
UID represents the file UID.
} Inline Model 24 {
Propagation (object, optional):
A propagation mode with the value [r]private, [r]shared, or [r]slave.
The permission mode for the tmpfs mount in an integer.
,
SizeBytes (integer, optional):
The size for the tmpfs mount in bytes.
} Inline Model 26 {
DriverConfig (Inline Model 31, optional):
Map of driver specific options
,
Labels (object, optional):
User-defined key/value metadata.
,
NoCopy (boolean, optional):
Populate volume with data from the target.
boolean
Default:
false
} Inline Model 27 {
File (string, optional):
Load credential spec from this file. The file is read by the daemon, and must be present in the
CredentialSpecs subdirectory in the docker data directory, which defaults to
C:\ProgramData\Docker\ on Windows.
For example, specifying spec.json loads C:\ProgramData\Docker\CredentialSpecs\spec.json.
> Note: CredentialSpec.File and CredentialSpec.Registry are mutually exclusive.
,
Registry (string, optional):
Load credential spec from this value in the Windows registry. The specified registry value must be
located in:
Array of network names or IDs to attach the service to.
,
RollbackConfig (Inline Model 6, optional):
Specification for the rollback strategy of the service.
,
TaskTemplate (TaskSpec, optional),
UpdateConfig (Inline Model 7, optional):
Specification for the update strategy of the service.
} Inline Model 2 {
CompletedAt (string, optional),
Message (string, optional),
StartedAt (string, optional),
State (string, optional) = ['updating', 'paused', 'completed']
string
Enum:
"updating", "paused", "completed"
} ObjectVersion {
Index (integer, optional)
} EndpointPortConfig {
Name (string, optional),
Protocol (string, optional) = ['tcp', 'udp']
string
Enum:
"tcp", "udp"
,
PublishedPort (integer, optional):
The port on the swarm hosts.
,
TargetPort (integer, optional):
The port inside the container.
} EndpointSpec {
Mode (string, optional):
The mode of resolution to use for internal load balancing between tasks.
= ['vip', 'dnsrr']
string
Default:
vip
Enum:
"vip", "dnsrr"
,
Ports (Array[EndpointPortConfig], optional):
List of exposed ports that this service is accessible on from the outside. Ports can only be provided if vip resolution mode is used.
} Inline Model 3 {
Addr (string, optional),
NetworkID (string, optional)
} Inline Model 4 {
Global (object, optional),
Replicated (Inline Model 8, optional)
} Inline Model 5 {
Aliases (Array[string], optional),
Target (string, optional)
} Inline Model 6 {
Delay (integer, optional):
Amount of time between rollback iterations, in nanoseconds.
,
FailureAction (string, optional):
Action to take if an rolled back task fails to run, or stops running during the rollback.
= ['continue', 'pause']
string
Enum:
"continue", "pause"
,
MaxFailureRatio (number, optional):
The fraction of tasks that may fail during a rollback before the failure action is invoked, specified as a floating point number between 0 and 1.
number
Default:
0
,
Monitor (integer, optional):
Amount of time to monitor each rolled back task for failures, in nanoseconds.
,
Order (string, optional):
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.
= ['stop-first', 'start-first']
string
Enum:
"stop-first", "start-first"
,
Parallelism (integer, optional):
Maximum number of tasks to be rolled back in one iteration (0 means unlimited parallelism).
} TaskSpec {
ContainerSpec (Inline Model 9, optional),
ForceUpdate (integer, optional):
A counter that triggers an update even if no relevant parameters have been changed.
,
LogDriver (Inline Model 10, optional):
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.
,
Networks (Array[Inline Model 11], optional),
Placement (Inline Model 12, optional),
Resources (Inline Model 13, optional):
Resource requirements which apply to each individual container created as part of the service.
,
RestartPolicy (Inline Model 14, optional):
Specification for the restart policy which applies to containers created as part of this service.
,
Runtime (string, optional):
Runtime is the type of runtime specified for the task executor.
} Inline Model 7 {
Delay (integer, optional):
Amount of time between updates, in nanoseconds.
,
FailureAction (string, optional):
Action to take if an updated task fails to run, or stops running during the update.
= ['continue', 'pause', 'rollback']
string
Enum:
"continue", "pause", "rollback"
,
MaxFailureRatio (number, optional):
The fraction of tasks that may fail during an update before the failure action is invoked, specified as a floating point number between 0 and 1.
number
Default:
0
,
Monitor (integer, optional):
Amount of time to monitor each updated task for failures, in nanoseconds.
,
Order (string, optional):
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.
= ['stop-first', 'start-first']
string
Enum:
"stop-first", "start-first"
,
Parallelism (integer, optional):
Maximum number of tasks to be updated in one iteration (0 means unlimited parallelism).
} Inline Model 8 {
Replicas (integer, optional)
} Inline Model 9 {
Args (Array[string], optional):
Arguments to the command.
,
Command (Array[string], optional):
The command to be run in the image.
,
Configs (Array[Inline Model 15], optional):
Configs contains references to zero or more configs that will be exposed to the service.
,
DNSConfig (Inline Model 16, optional):
Specification for DNS related configurations in resolver configuration file (resolv.conf).
,
Dir (string, optional):
The working directory for commands to run in.
,
Env (Array[string], optional):
A list of environment variables in the form VAR=value.
,
Groups (Array[string], optional):
A list of additional groups that the container process will run as.
,
HealthCheck (HealthConfig, optional),
Hostname (string, optional):
The hostname to use for the container, as a valid RFC 1123 hostname.
,
Hosts (Array[string], optional):
A list of hostnames/IP mappings to add to the container's /etc/hosts file.
The format of extra hosts on swarmkit is specified in:
http://man7.org/linux/man-pages/man5/hosts.5.html
IP_address canonical_hostname [aliases...]
,
Image (string, optional):
The image name to use for the container.
,
Labels (object, optional):
User-defined key/value data.
,
Mounts (Array[Mount], optional):
Specification for mounts to be added to containers created as part of the service.
,
OpenStdin (boolean, optional):
Open stdin
,
Privileges (Inline Model 17, optional):
Security options for the container
,
ReadOnly (boolean, optional):
Mount the container's root filesystem as read only.
,
Secrets (Array[Inline Model 18], optional):
Secrets contains references to zero or more secrets that will be exposed to the service.
,
StopGracePeriod (integer, optional):
Amount of time to wait for the container to terminate before forcefully killing it.
,
StopSignal (string, optional):
Signal to stop the container.
,
TTY (boolean, optional):
Whether a pseudo-TTY should be allocated.
,
User (string, optional):
The user inside the container.
} Inline Model 10 {
Name (string, optional),
Options (object, optional)
} Inline Model 11 {
Aliases (Array[string], optional),
Target (string, optional)
} Inline Model 12 {
Constraints (Array[string], optional):
An array of constraints.
,
Platforms (Array[Inline Model 19], optional):
An array of supported platforms.
,
Preferences (Array[Inline Model 20], optional):
Preferences provide a way to make the scheduler aware of factors such as topology. They are provided in order from highest to lowest precedence.
} Inline Model 13 {
Limits (Inline Model 21, optional):
Define resources limits.
,
Reservation (Inline Model 22, optional):
Define resources reservation.
} Inline Model 14 {
Condition (string, optional):
Condition for restart.
= ['none', 'on-failure', 'any']
string
Enum:
"none", "on-failure", "any"
,
Delay (integer, optional):
Delay between restart attempts.
,
MaxAttempts (integer, optional):
Maximum attempts to restart a given container before giving up (default value is 0, which is ignored).
integer
Default:
0
,
Window (integer, optional):
Windows is the time window used to evaluate the restart policy (default value is 0, which is unbounded).
integer
Default:
0
} Inline Model 15 {
ConfigID (string, optional):
ConfigID represents the ID of the specific config that we're referencing.
,
ConfigName (string, optional):
ConfigName is the name of the config that this references, but this is just provided for
lookup/display purposes. The config in the reference will be identified by its ID.
,
File (Inline Model 23, optional):
File represents a specific target that is backed by a file.
} Inline Model 16 {
Nameservers (Array[string], optional):
The IP addresses of the name servers.
,
Options (Array[string], optional):
A list of internal resolver variables to be modified (e.g., debug, ndots:3, etc.).
,
Search (Array[string], optional):
A search list for host-name lookup.
} HealthConfig {
Interval (integer, optional):
The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
,
Retries (integer, optional):
The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit.
,
StartPeriod (integer, optional):
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.
,
Test (Array[string], optional):
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
,
Timeout (integer, optional):
The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
} Mount {
BindOptions (Inline Model 24, optional):
Optional configuration for the bind type.
,
Consistency (string, optional):
The consistency requirement for the mount: default, consistent, cached, or delegated.
,
ReadOnly (boolean, optional):
Whether the mount should be read-only.
,
Source (string, optional):
Mount source (e.g. a volume name, a host path).
,
Target (string, optional):
Container path.
,
TmpfsOptions (Inline Model 25, optional):
Optional configuration for the tmpfs type.
,
Type (string, optional):
The mount type. Available types:
bind Mounts a file or directory from the host into the container. Must exist prior to creating the container.
volume Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are not removed when the container is removed.
tmpfs Create a tmpfs with the given options. The mount source cannot be specified for tmpfs.
= ['bind', 'volume', 'tmpfs']
string
Enum:
"bind", "volume", "tmpfs"
,
VolumeOptions (Inline Model 26, optional):
Optional configuration for the volume type.
} Inline Model 17 {
CredentialSpec (Inline Model 27, optional):
CredentialSpec for managed service account (Windows only)
,
SELinuxContext (Inline Model 28, optional):
SELinux labels of the container
} Inline Model 18 {
File (Inline Model 29, optional):
File represents a specific target that is backed by a file.
,
SecretID (string, optional):
SecretID represents the ID of the specific secret that we're referencing.
,
SecretName (string, optional):
SecretName is the name of the secret that this references, but this is just provided for
lookup/display purposes. The secret in the reference will be identified by its ID.
} Inline Model 19 {
Architecture (string, optional),
OS (string, optional)
} Inline Model 20 {
Spread (Inline Model 30, optional)
} Inline Model 21 {
MemoryBytes (integer, optional):
Memory limit in Bytes.
,
NanoCPUs (integer, optional):
CPU limit in units of 10-9 CPU shares.
} Inline Model 22 {
MemoryBytes (integer, optional):
Memory reservation in Bytes.
,
NanoCPUs (integer, optional):
CPU reservation in units of 10-9 CPU shares.
} Inline Model 23 {
GID (string, optional):
GID represents the file GID.
,
Mode (integer, optional):
Mode represents the FileMode of the file.
,
Name (string, optional):
Name represents the final filename in the filesystem.
,
UID (string, optional):
UID represents the file UID.
} Inline Model 24 {
Propagation (object, optional):
A propagation mode with the value [r]private, [r]shared, or [r]slave.
The permission mode for the tmpfs mount in an integer.
,
SizeBytes (integer, optional):
The size for the tmpfs mount in bytes.
} Inline Model 26 {
DriverConfig (Inline Model 31, optional):
Map of driver specific options
,
Labels (object, optional):
User-defined key/value metadata.
,
NoCopy (boolean, optional):
Populate volume with data from the target.
boolean
Default:
false
} Inline Model 27 {
File (string, optional):
Load credential spec from this file. The file is read by the daemon, and must be present in the
CredentialSpecs subdirectory in the docker data directory, which defaults to
C:\ProgramData\Docker\ on Windows.
For example, specifying spec.json loads C:\ProgramData\Docker\CredentialSpecs\spec.json.
> Note: CredentialSpec.File and CredentialSpec.Registry are mutually exclusive.
,
Registry (string, optional):
Load credential spec from this value in the Windows registry. The specified registry value must be
located in:
A counter that triggers an update even if no relevant parameters have been changed.
,
LogDriver (Inline Model 3, optional):
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.
,
Networks (Array[Inline Model 4], optional),
Placement (Inline Model 5, optional),
Resources (Inline Model 6, optional):
Resource requirements which apply to each individual container created as part of the service.
,
RestartPolicy (Inline Model 7, optional):
Specification for the restart policy which applies to containers created as part of this service.
,
Runtime (string, optional):
Runtime is the type of runtime specified for the task executor.
Configs contains references to zero or more configs that will be exposed to the service.
,
DNSConfig (Inline Model 10, optional):
Specification for DNS related configurations in resolver configuration file (resolv.conf).
,
Dir (string, optional):
The working directory for commands to run in.
,
Env (Array[string], optional):
A list of environment variables in the form VAR=value.
,
Groups (Array[string], optional):
A list of additional groups that the container process will run as.
,
HealthCheck (HealthConfig, optional),
Hostname (string, optional):
The hostname to use for the container, as a valid RFC 1123 hostname.
,
Hosts (Array[string], optional):
A list of hostnames/IP mappings to add to the container's /etc/hosts file.
The format of extra hosts on swarmkit is specified in:
http://man7.org/linux/man-pages/man5/hosts.5.html
IP_address canonical_hostname [aliases...]
,
Image (string, optional):
The image name to use for the container.
,
Labels (object, optional):
User-defined key/value data.
,
Mounts (Array[Mount], optional):
Specification for mounts to be added to containers created as part of the service.
,
OpenStdin (boolean, optional):
Open stdin
,
Privileges (Inline Model 11, optional):
Security options for the container
,
ReadOnly (boolean, optional):
Mount the container's root filesystem as read only.
,
Secrets (Array[Inline Model 12], optional):
Secrets contains references to zero or more secrets that will be exposed to the service.
,
StopGracePeriod (integer, optional):
Amount of time to wait for the container to terminate before forcefully killing it.
,
StopSignal (string, optional):
Signal to stop the container.
,
TTY (boolean, optional):
Whether a pseudo-TTY should be allocated.
,
User (string, optional):
The user inside the container.
} Inline Model 3 {
Name (string, optional),
Options (object, optional)
} Inline Model 4 {
Aliases (Array[string], optional),
Target (string, optional)
} Inline Model 5 {
Constraints (Array[string], optional):
An array of constraints.
,
Platforms (Array[Inline Model 13], optional):
An array of supported platforms.
,
Preferences (Array[Inline Model 14], optional):
Preferences provide a way to make the scheduler aware of factors such as topology. They are provided in order from highest to lowest precedence.
} Inline Model 6 {
Limits (Inline Model 15, optional):
Define resources limits.
,
Reservation (Inline Model 16, optional):
Define resources reservation.
} Inline Model 7 {
Condition (string, optional):
Condition for restart.
= ['none', 'on-failure', 'any']
string
Enum:
"none", "on-failure", "any"
,
Delay (integer, optional):
Delay between restart attempts.
,
MaxAttempts (integer, optional):
Maximum attempts to restart a given container before giving up (default value is 0, which is ignored).
integer
Default:
0
,
Window (integer, optional):
Windows is the time window used to evaluate the restart policy (default value is 0, which is unbounded).
integer
Default:
0
} Inline Model 8 {
ContainerID (string, optional),
ExitCode (integer, optional),
PID (integer, optional)
} Inline Model 9 {
ConfigID (string, optional):
ConfigID represents the ID of the specific config that we're referencing.
,
ConfigName (string, optional):
ConfigName is the name of the config that this references, but this is just provided for
lookup/display purposes. The config in the reference will be identified by its ID.
,
File (Inline Model 17, optional):
File represents a specific target that is backed by a file.
} Inline Model 10 {
Nameservers (Array[string], optional):
The IP addresses of the name servers.
,
Options (Array[string], optional):
A list of internal resolver variables to be modified (e.g., debug, ndots:3, etc.).
,
Search (Array[string], optional):
A search list for host-name lookup.
} HealthConfig {
Interval (integer, optional):
The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
,
Retries (integer, optional):
The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit.
,
StartPeriod (integer, optional):
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.
,
Test (Array[string], optional):
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
,
Timeout (integer, optional):
The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
} Mount {
BindOptions (Inline Model 18, optional):
Optional configuration for the bind type.
,
Consistency (string, optional):
The consistency requirement for the mount: default, consistent, cached, or delegated.
,
ReadOnly (boolean, optional):
Whether the mount should be read-only.
,
Source (string, optional):
Mount source (e.g. a volume name, a host path).
,
Target (string, optional):
Container path.
,
TmpfsOptions (Inline Model 19, optional):
Optional configuration for the tmpfs type.
,
Type (string, optional):
The mount type. Available types:
bind Mounts a file or directory from the host into the container. Must exist prior to creating the container.
volume Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are not removed when the container is removed.
tmpfs Create a tmpfs with the given options. The mount source cannot be specified for tmpfs.
= ['bind', 'volume', 'tmpfs']
string
Enum:
"bind", "volume", "tmpfs"
,
VolumeOptions (Inline Model 20, optional):
Optional configuration for the volume type.
} Inline Model 11 {
CredentialSpec (Inline Model 21, optional):
CredentialSpec for managed service account (Windows only)
,
SELinuxContext (Inline Model 22, optional):
SELinux labels of the container
} Inline Model 12 {
File (Inline Model 23, optional):
File represents a specific target that is backed by a file.
,
SecretID (string, optional):
SecretID represents the ID of the specific secret that we're referencing.
,
SecretName (string, optional):
SecretName is the name of the secret that this references, but this is just provided for
lookup/display purposes. The secret in the reference will be identified by its ID.
} Inline Model 13 {
Architecture (string, optional),
OS (string, optional)
} Inline Model 14 {
Spread (Inline Model 24, optional)
} Inline Model 15 {
MemoryBytes (integer, optional):
Memory limit in Bytes.
,
NanoCPUs (integer, optional):
CPU limit in units of 10-9 CPU shares.
} Inline Model 16 {
MemoryBytes (integer, optional):
Memory reservation in Bytes.
,
NanoCPUs (integer, optional):
CPU reservation in units of 10-9 CPU shares.
} Inline Model 17 {
GID (string, optional):
GID represents the file GID.
,
Mode (integer, optional):
Mode represents the FileMode of the file.
,
Name (string, optional):
Name represents the final filename in the filesystem.
,
UID (string, optional):
UID represents the file UID.
} Inline Model 18 {
Propagation (object, optional):
A propagation mode with the value [r]private, [r]shared, or [r]slave.
The permission mode for the tmpfs mount in an integer.
,
SizeBytes (integer, optional):
The size for the tmpfs mount in bytes.
} Inline Model 20 {
DriverConfig (Inline Model 25, optional):
Map of driver specific options
,
Labels (object, optional):
User-defined key/value metadata.
,
NoCopy (boolean, optional):
Populate volume with data from the target.
boolean
Default:
false
} Inline Model 21 {
File (string, optional):
Load credential spec from this file. The file is read by the daemon, and must be present in the
CredentialSpecs subdirectory in the docker data directory, which defaults to
C:\ProgramData\Docker\ on Windows.
For example, specifying spec.json loads C:\ProgramData\Docker\CredentialSpecs\spec.json.
> Note: CredentialSpec.File and CredentialSpec.Registry are mutually exclusive.
,
Registry (string, optional):
Load credential spec from this value in the Windows registry. The specified registry value must be
located in:
A counter that triggers an update even if no relevant parameters have been changed.
,
LogDriver (Inline Model 3, optional):
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.
,
Networks (Array[Inline Model 4], optional),
Placement (Inline Model 5, optional),
Resources (Inline Model 6, optional):
Resource requirements which apply to each individual container created as part of the service.
,
RestartPolicy (Inline Model 7, optional):
Specification for the restart policy which applies to containers created as part of this service.
,
Runtime (string, optional):
Runtime is the type of runtime specified for the task executor.
Configs contains references to zero or more configs that will be exposed to the service.
,
DNSConfig (Inline Model 10, optional):
Specification for DNS related configurations in resolver configuration file (resolv.conf).
,
Dir (string, optional):
The working directory for commands to run in.
,
Env (Array[string], optional):
A list of environment variables in the form VAR=value.
,
Groups (Array[string], optional):
A list of additional groups that the container process will run as.
,
HealthCheck (HealthConfig, optional),
Hostname (string, optional):
The hostname to use for the container, as a valid RFC 1123 hostname.
,
Hosts (Array[string], optional):
A list of hostnames/IP mappings to add to the container's /etc/hosts file.
The format of extra hosts on swarmkit is specified in:
http://man7.org/linux/man-pages/man5/hosts.5.html
IP_address canonical_hostname [aliases...]
,
Image (string, optional):
The image name to use for the container.
,
Labels (object, optional):
User-defined key/value data.
,
Mounts (Array[Mount], optional):
Specification for mounts to be added to containers created as part of the service.
,
OpenStdin (boolean, optional):
Open stdin
,
Privileges (Inline Model 11, optional):
Security options for the container
,
ReadOnly (boolean, optional):
Mount the container's root filesystem as read only.
,
Secrets (Array[Inline Model 12], optional):
Secrets contains references to zero or more secrets that will be exposed to the service.
,
StopGracePeriod (integer, optional):
Amount of time to wait for the container to terminate before forcefully killing it.
,
StopSignal (string, optional):
Signal to stop the container.
,
TTY (boolean, optional):
Whether a pseudo-TTY should be allocated.
,
User (string, optional):
The user inside the container.
} Inline Model 3 {
Name (string, optional),
Options (object, optional)
} Inline Model 4 {
Aliases (Array[string], optional),
Target (string, optional)
} Inline Model 5 {
Constraints (Array[string], optional):
An array of constraints.
,
Platforms (Array[Inline Model 13], optional):
An array of supported platforms.
,
Preferences (Array[Inline Model 14], optional):
Preferences provide a way to make the scheduler aware of factors such as topology. They are provided in order from highest to lowest precedence.
} Inline Model 6 {
Limits (Inline Model 15, optional):
Define resources limits.
,
Reservation (Inline Model 16, optional):
Define resources reservation.
} Inline Model 7 {
Condition (string, optional):
Condition for restart.
= ['none', 'on-failure', 'any']
string
Enum:
"none", "on-failure", "any"
,
Delay (integer, optional):
Delay between restart attempts.
,
MaxAttempts (integer, optional):
Maximum attempts to restart a given container before giving up (default value is 0, which is ignored).
integer
Default:
0
,
Window (integer, optional):
Windows is the time window used to evaluate the restart policy (default value is 0, which is unbounded).
integer
Default:
0
} Inline Model 8 {
ContainerID (string, optional),
ExitCode (integer, optional),
PID (integer, optional)
} Inline Model 9 {
ConfigID (string, optional):
ConfigID represents the ID of the specific config that we're referencing.
,
ConfigName (string, optional):
ConfigName is the name of the config that this references, but this is just provided for
lookup/display purposes. The config in the reference will be identified by its ID.
,
File (Inline Model 17, optional):
File represents a specific target that is backed by a file.
} Inline Model 10 {
Nameservers (Array[string], optional):
The IP addresses of the name servers.
,
Options (Array[string], optional):
A list of internal resolver variables to be modified (e.g., debug, ndots:3, etc.).
,
Search (Array[string], optional):
A search list for host-name lookup.
} HealthConfig {
Interval (integer, optional):
The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
,
Retries (integer, optional):
The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit.
,
StartPeriod (integer, optional):
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.
,
Test (Array[string], optional):
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
,
Timeout (integer, optional):
The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). 0 means inherit.
} Mount {
BindOptions (Inline Model 18, optional):
Optional configuration for the bind type.
,
Consistency (string, optional):
The consistency requirement for the mount: default, consistent, cached, or delegated.
,
ReadOnly (boolean, optional):
Whether the mount should be read-only.
,
Source (string, optional):
Mount source (e.g. a volume name, a host path).
,
Target (string, optional):
Container path.
,
TmpfsOptions (Inline Model 19, optional):
Optional configuration for the tmpfs type.
,
Type (string, optional):
The mount type. Available types:
bind Mounts a file or directory from the host into the container. Must exist prior to creating the container.
volume Creates a volume with the given name and options (or uses a pre-existing volume with the same name and options). These are not removed when the container is removed.
tmpfs Create a tmpfs with the given options. The mount source cannot be specified for tmpfs.
= ['bind', 'volume', 'tmpfs']
string
Enum:
"bind", "volume", "tmpfs"
,
VolumeOptions (Inline Model 20, optional):
Optional configuration for the volume type.
} Inline Model 11 {
CredentialSpec (Inline Model 21, optional):
CredentialSpec for managed service account (Windows only)
,
SELinuxContext (Inline Model 22, optional):
SELinux labels of the container
} Inline Model 12 {
File (Inline Model 23, optional):
File represents a specific target that is backed by a file.
,
SecretID (string, optional):
SecretID represents the ID of the specific secret that we're referencing.
,
SecretName (string, optional):
SecretName is the name of the secret that this references, but this is just provided for
lookup/display purposes. The secret in the reference will be identified by its ID.
} Inline Model 13 {
Architecture (string, optional),
OS (string, optional)
} Inline Model 14 {
Spread (Inline Model 24, optional)
} Inline Model 15 {
MemoryBytes (integer, optional):
Memory limit in Bytes.
,
NanoCPUs (integer, optional):
CPU limit in units of 10-9 CPU shares.
} Inline Model 16 {
MemoryBytes (integer, optional):
Memory reservation in Bytes.
,
NanoCPUs (integer, optional):
CPU reservation in units of 10-9 CPU shares.
} Inline Model 17 {
GID (string, optional):
GID represents the file GID.
,
Mode (integer, optional):
Mode represents the FileMode of the file.
,
Name (string, optional):
Name represents the final filename in the filesystem.
,
UID (string, optional):
UID represents the file UID.
} Inline Model 18 {
Propagation (object, optional):
A propagation mode with the value [r]private, [r]shared, or [r]slave.
The permission mode for the tmpfs mount in an integer.
,
SizeBytes (integer, optional):
The size for the tmpfs mount in bytes.
} Inline Model 20 {
DriverConfig (Inline Model 25, optional):
Map of driver specific options
,
Labels (object, optional):
User-defined key/value metadata.
,
NoCopy (boolean, optional):
Populate volume with data from the target.
boolean
Default:
false
} Inline Model 21 {
File (string, optional):
Load credential spec from this file. The file is read by the daemon, and must be present in the
CredentialSpecs subdirectory in the docker data directory, which defaults to
C:\ProgramData\Docker\ on Windows.
For example, specifying spec.json loads C:\ProgramData\Docker\CredentialSpecs\spec.json.
> Note: CredentialSpec.File and CredentialSpec.Registry are mutually exclusive.
,
Registry (string, optional):
Load credential spec from this value in the Windows registry. The specified registry value must be
located in:
Get options for syncing members of a team.
Requires authentication and authorization as an admin user, an admin member of
the organization, or an admin member of the team.
Whether to enable LDAP syncing. If false, all other fields are ignored
,
groupDN (string):
The distinguished name of the LDAP group. Applicable only if selectGroupMembers is true, ignored otherwise
,
groupMemberAttr (string):
The name of the LDAP group entry attribute which corresponds to distinguished names of members. Applicable only if selectGroupMembers is true, ignored otherwise
,
searchBaseDN (string):
The distinguished name of the element from which the LDAP server will search for users. Applicable only if selectGroupMembers is false, ignored otherwise
,
searchFilter (string):
The LDAP search filter used to select users if selectGroupMembers is false, may be left blank
,
searchScopeSubtree (boolean):
Whether to search for users in the entire subtree of the base DN or to only search one level under the base DN (if false). Applicable only if selectGroupMembers is false, ignored otherwise
,
selectGroupMembers (boolean):
Whether to sync using a group DN and member attribute selection or to use a search filter (if false)
Set options for syncing members of a team.
Enabling sync of team members will disable the ability to manually manage team
membership for any users imported from LDAP. Their team membership is instead
managed by the LDAP sync.
Requires authentication and authorization as an admin user, an admin member of
the organization, or an admin member of the team.
Whether to enable LDAP syncing. If false, all other fields are ignored
,
groupDN (string):
The distinguished name of the LDAP group. Applicable only if selectGroupMembers is true, ignored otherwise
,
groupMemberAttr (string):
The name of the LDAP group entry attribute which corresponds to distinguished names of members. Applicable only if selectGroupMembers is true, ignored otherwise
,
searchBaseDN (string):
The distinguished name of the element from which the LDAP server will search for users. Applicable only if selectGroupMembers is false, ignored otherwise
,
searchFilter (string):
The LDAP search filter used to select users if selectGroupMembers is false, may be left blank
,
searchScopeSubtree (boolean):
Whether to search for users in the entire subtree of the base DN or to only search one level under the base DN (if false). Applicable only if selectGroupMembers is false, ignored otherwise
,
selectGroupMembers (boolean):
Whether to sync using a group DN and member attribute selection or to use a search filter (if false)
List members of a team.
Lists memberships in ascending order by user ID.
Requires authentication and authorization as an admin user or a member of the
organization.
Remove a member from a team.
The user will remain a member of the organization. If team members are
configured to be synced with LDAP, users which are imported from LDAP cannot be
manually removed as members of the team and must be synced with LDAP.
Requires authentication and authorization as an admin user, an admin member of
the organization, or an admin member of the team.
Add a user to a team.
The user will be added as a member of the organization if they are not already.
If team members are configured to be synced with LDAP, users which are imported
from LDAP cannot be manually added as members of the team and must be synced
with LDAP.
Requires authentication and authorization as an admin user, an admin member of
the organization, or an admin member of the team.
List teams in an organization.
Lists teams in ascending order by name.
Requires authentication and authorization as an admin user or a member of the
organization.
Update details for a team.
Requires authentication and authorization as an admin user, an admin member of
the organization, or an admin member of the team.
Get options for syncing members of a team.
Requires authentication and authorization as an admin user, an admin member of
the organization, or an admin member of the team.
Whether to enable LDAP syncing. If false, all other fields are ignored
,
groupDN (string):
The distinguished name of the LDAP group. Applicable only if selectGroupMembers is true, ignored otherwise
,
groupMemberAttr (string):
The name of the LDAP group entry attribute which corresponds to distinguished names of members. Applicable only if selectGroupMembers is true, ignored otherwise
,
searchBaseDN (string):
The distinguished name of the element from which the LDAP server will search for users. Applicable only if selectGroupMembers is false, ignored otherwise
,
searchFilter (string):
The LDAP search filter used to select users if selectGroupMembers is false, may be left blank
,
searchScopeSubtree (boolean):
Whether to search for users in the entire subtree of the base DN or to only search one level under the base DN (if false). Applicable only if selectGroupMembers is false, ignored otherwise
,
selectGroupMembers (boolean):
Whether to sync using a group DN and member attribute selection or to use a search filter (if false)
Set options for syncing members of a team.
Enabling sync of team members will disable the ability to manually manage team
membership for any users imported from LDAP. Their team membership is instead
managed by the LDAP sync.
Requires authentication and authorization as an admin user, an admin member of
the organization, or an admin member of the team.
Whether to enable LDAP syncing. If false, all other fields are ignored
,
groupDN (string):
The distinguished name of the LDAP group. Applicable only if selectGroupMembers is true, ignored otherwise
,
groupMemberAttr (string):
The name of the LDAP group entry attribute which corresponds to distinguished names of members. Applicable only if selectGroupMembers is true, ignored otherwise
,
searchBaseDN (string):
The distinguished name of the element from which the LDAP server will search for users. Applicable only if selectGroupMembers is false, ignored otherwise
,
searchFilter (string):
The LDAP search filter used to select users if selectGroupMembers is false, may be left blank
,
searchScopeSubtree (boolean):
Whether to search for users in the entire subtree of the base DN or to only search one level under the base DN (if false). Applicable only if selectGroupMembers is false, ignored otherwise
,
selectGroupMembers (boolean):
Whether to sync using a group DN and member attribute selection or to use a search filter (if false)
List members of a team.
Lists memberships in ascending order by user ID.
Requires authentication and authorization as an admin user or a member of the
organization.
Remove a member from a team.
The user will remain a member of the organization. If team members are
configured to be synced with LDAP, users which are imported from LDAP cannot be
manually removed as members of the team and must be synced with LDAP.
Requires authentication and authorization as an admin user, an admin member of
the organization, or an admin member of the team.
Add a user to a team.
The user will be added as a member of the organization if they are not already.
If team members are configured to be synced with LDAP, users which are imported
from LDAP cannot be manually added as members of the team and must be synced
with LDAP.
Requires authentication and authorization as an admin user, an admin member of
the organization, or an admin member of the team.
Check the health of a UCP manager.
Use the _ping endpoint to check the health of a single UCP manager node. The UCP manager validates that all of its internal components are working, and it returns either 200, if all components are healthy, or 500, if any aren't healthy.
If you’re accessing the _ping endpoint through a load balancer, you have no way of knowing which UCP manager node isn't healthy, because any manager node may be serving your request. Make sure you’re connecting directly to the URL of a manager node, and not a load balancer.
continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response.
The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
,
creationTimestamp (string, optional):
CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
,
deletionTimestamp (string, optional):
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.
,
generateName (string, optional):
GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
,
initializers (v1.Initializers, optional):
An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects.
When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user.
Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://v1-8.docs.kubernetes.io/docs/concepts/overview/working-with-objects/names/
,
namespace (string, optional):
Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
,
resourceVersion (string, optional):
An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
SelfLink is a URL representing this object. Populated by the system. Read-only.
,
uid (string, optional):
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.
,
result (v1.Status, optional):
If result is set with the Failure field, the object will be persisted to storage and then deleted, ensuring that other clients can observe the deletion.
} v1.OwnerReference {
apiVersion (string):
API version of the referent.
,
blockOwnerDeletion (boolean, optional):
If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
,
controller (boolean, optional):
If true, this reference points to the managing controller.
Suggested HTTP return code for this status, 0 if not set.
,
details (v1.StatusDetails, optional):
Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
,
retryAfterSeconds (integer, optional):
If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.
The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
Examples:
"name" - the field "name" on the current resource
"items[0].name" - the field "name" on the first array entry in "items"
,
message (string, optional):
A human-readable description of the cause of the error. This field may be presented as-is to a reader.
,
reason (string, optional):
A machine-readable description of the cause of the error. If this value is empty there is no information available.
List a user's organization memberships.
Lists organization memberships in ascending order by organization ID.
Requires authentication and authorization as an admin user or the target user.
If the name is prefixed with the name of a node, the request is sent to the specified node. Use the '/' character to distinguish the node name, like testnode/testvolume.
Warnings that occurred when fetching the list of volumes
} Volume {
Driver (string):
Name of the volume driver used by the volume.
,
Labels (object):
User-defined key/value metadata.
,
Mountpoint (string):
Mount path of the volume on the host.
,
Name (string):
Name of the volume.
,
Options (object):
The driver specific options used when creating the volume.
,
Scope (string):
The level at which the volume exists. Either global for cluster-wide, or local for machine level.
= ['local', 'global']
string
Default:
local
Enum:
"local", "global"
,
Status (object, optional):
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.
,
UsageData (Inline Model 1, optional):
Usage details about the volume. This information is used by the
GET /system/df endpoint, and omitted in other endpoints.
} Inline Model 1 {
RefCount (integer):
The number of containers referencing this volume. This field
is set to -1 if the reference-count is not available.
integer
Default:
-1
,
Size (integer):
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")
The driver specific options used when creating the volume.
,
Scope (string):
The level at which the volume exists. Either global for cluster-wide, or local for machine level.
= ['local', 'global']
string
Default:
local
Enum:
"local", "global"
,
Status (object, optional):
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.
,
UsageData (Inline Model 1, optional):
Usage details about the volume. This information is used by the
GET /system/df endpoint, and omitted in other endpoints.
} Inline Model 1 {
RefCount (integer):
The number of containers referencing this volume. This field
is set to -1 if the reference-count is not available.
integer
Default:
-1
,
Size (integer):
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")
If the name is prefixed with the name of a node, the request is sent to the specified node. Use the '/' character to distinguish the node name, like testnode/testvolume.
The driver specific options used when creating the volume.
,
Scope (string):
The level at which the volume exists. Either global for cluster-wide, or local for machine level.
= ['local', 'global']
string
Default:
local
Enum:
"local", "global"
,
Status (object, optional):
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.
,
UsageData (Inline Model 1, optional):
Usage details about the volume. This information is used by the
GET /system/df endpoint, and omitted in other endpoints.
} Inline Model 1 {
RefCount (integer):
The number of containers referencing this volume. This field
is set to -1 if the reference-count is not available.
integer
Default:
-1
,
Size (integer):
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")