EndpointPortConfigProtocolSctp captures enum value "sctp".

EndpointPortConfigProtocolTCP captures enum value "tcp".

EndpointPortConfigProtocolUDP captures enum value "udp".

EndpointPortConfigPublishModeHost captures enum value "host".

EndpointPortConfigPublishModeIngress captures enum value "ingress".

EndpointSpecModeDnsrr captures enum value "dnsrr".

EndpointSpecModeVip captures enum value "vip".

HostConfigAO1LogConfigTypeAwslogs captures enum value "awslogs".

HostConfigAO1LogConfigTypeEtwlogs captures enum value "etwlogs".

HostConfigAO1LogConfigTypeFluentd captures enum value "fluentd".

HostConfigAO1LogConfigTypeGelf captures enum value "gelf".

HostConfigAO1LogConfigTypeJournald captures enum value "journald".

HostConfigAO1LogConfigTypeJSONDashFile captures enum value "json-file".

HostConfigAO1LogConfigTypeNone captures enum value "none".

HostConfigAO1LogConfigTypeSplunk captures enum value "splunk".

HostConfigAO1LogConfigTypeSyslog captures enum value "syslog".

LocalNodeStateActive captures enum value "active".

LocalNodeStateEmpty captures enum value "".

LocalNodeStateError captures enum value "error".

LocalNodeStateInactive captures enum value "inactive".

LocalNodeStateLocked captures enum value "locked".

LocalNodeStatePending captures enum value "pending".

MountBindOptionsPropagationPrivate captures enum value "private".

MountBindOptionsPropagationRprivate captures enum value "rprivate".

MountBindOptionsPropagationRshared captures enum value "rshared".

MountBindOptionsPropagationRslave captures enum value "rslave".

MountBindOptionsPropagationShared captures enum value "shared".

MountBindOptionsPropagationSlave captures enum value "slave".

MountTypeBind captures enum value "bind".

MountTypeNpipe captures enum value "npipe".

MountTypeTmpfs captures enum value "tmpfs".

MountTypeVolume captures enum value "volume".

NodeSpecAvailabilityActive captures enum value "active".

NodeSpecAvailabilityDrain captures enum value "drain".

NodeSpecAvailabilityPause captures enum value "pause".

NodeSpecRoleManager captures enum value "manager".

NodeSpecRoleWorker captures enum value "worker".

NodeStateDisconnected captures enum value "disconnected".

NodeStateDown captures enum value "down".

NodeStateReady captures enum value "ready".

NodeStateUnknown captures enum value "unknown".

PluginConfigInterfaceProtocolSchemeEmpty captures enum value "".

PluginConfigInterfaceProtocolSchemeMobyDotPluginsDotHTTPV1 captures enum value "moby.plugins.http/v1".

PortTypeSctp captures enum value "sctp".

PortTypeTCP captures enum value "tcp".

PortTypeUDP captures enum value "udp".

ReachabilityReachable captures enum value "reachable".

ReachabilityUnknown captures enum value "unknown".

ReachabilityUnreachable captures enum value "unreachable".

RestartPolicyNameAlways captures enum value "always".

RestartPolicyNameEmpty captures enum value "".

RestartPolicyNameOnDashFailure captures enum value "on-failure".

RestartPolicyNameUnlessDashStopped captures enum value "unless-stopped".

ServiceSpecRollbackConfigFailureActionContinue captures enum value "continue".

ServiceSpecRollbackConfigFailureActionPause captures enum value "pause".

ServiceSpecRollbackConfigOrderStartDashFirst captures enum value "start-first".

ServiceSpecRollbackConfigOrderStopDashFirst captures enum value "stop-first".

ServiceSpecUpdateConfigFailureActionContinue captures enum value "continue".

ServiceSpecUpdateConfigFailureActionPause captures enum value "pause".

ServiceSpecUpdateConfigFailureActionRollback captures enum value "rollback".

ServiceSpecUpdateConfigOrderStartDashFirst captures enum value "start-first".

ServiceSpecUpdateConfigOrderStopDashFirst captures enum value "stop-first".

ServiceUpdateStatusStateCompleted captures enum value "completed".

ServiceUpdateStatusStatePaused captures enum value "paused".

ServiceUpdateStatusStateUpdating captures enum value "updating".

SwarmSpecCAConfigExternalCAsItems0ProtocolCfssl captures enum value "cfssl".

SystemInfoCgroupDriverCgroupfs captures enum value "cgroupfs".

SystemInfoCgroupDriverNone captures enum value "none".

SystemInfoCgroupDriverSystemd captures enum value "systemd".

SystemInfoIsolationDefault captures enum value "default".

SystemInfoIsolationHyperv captures enum value "hyperv".

SystemInfoIsolationProcess captures enum value "process".

TaskSpecContainerSpecIsolationDefault captures enum value "default".

TaskSpecContainerSpecIsolationHyperv captures enum value "hyperv".

TaskSpecContainerSpecIsolationProcess captures enum value "process".

TaskSpecRestartPolicyConditionAny captures enum value "any".

TaskSpecRestartPolicyConditionNone captures enum value "none".

TaskSpecRestartPolicyConditionOnDashFailure captures enum value "on-failure".

TaskStateAccepted captures enum value "accepted".

TaskStateAllocated captures enum value "allocated".

TaskStateAssigned captures enum value "assigned".

TaskStateComplete captures enum value "complete".

TaskStateFailed captures enum value "failed".

TaskStateNew captures enum value "new".

TaskStateOrphaned captures enum value "orphaned".

TaskStatePending captures enum value "pending".

TaskStatePreparing captures enum value "preparing".

TaskStateReady captures enum value "ready".

TaskStateRejected captures enum value "rejected".

TaskStateRemove captures enum value "remove".

TaskStateRunning captures enum value "running".

TaskStateShutdown captures enum value "shutdown".

TaskStateStarting captures enum value "starting".

VolumeScopeGlobal captures enum value "global".

VolumeScopeLocal captures enum value "local".

Address Address represents an IPv4 or IPv6 IP address.

AuthConfig auth config Example: {"password":"xxxx","serveraddress":"https://index.docker.io/v1/","username":"hannibal"} swagger:model AuthConfig.

BuildCache build cache swagger:model BuildCache.

BuildInfo build info swagger:model BuildInfo.

ClusterInfo ClusterInfo represents information about the swarm as is returned by the "/info" endpoint.

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

Config config swagger:model Config.

ConfigSpec config spec swagger:model ConfigSpec.

ContainerConfig Configuration for a container that is portable between hosts swagger:model ContainerConfig.

ContainerSummaryItems0 container summary items0 swagger:model ContainerSummaryItems0.

ContainerSummaryItems0HostConfig container summary items0 host config swagger:model ContainerSummaryItems0HostConfig.

ContainerSummaryItems0NetworkSettings A summary of the container's network settings swagger:model ContainerSummaryItems0NetworkSettings.

CreateImageInfo create image info swagger:model CreateImageInfo.

DeviceMapping A device mapping between the host and container Example: {"CgroupPermissions":"mrw","PathInContainer":"/dev/deviceName","PathOnHost":"/dev/deviceName"} swagger:model DeviceMapping.

DeviceRequest A request for devices to be sent to device drivers swagger:model DeviceRequest.

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

EndpointIPAMConfig EndpointIPAMConfig represents an endpoint's IPAM configuration.

EndpointPortConfig endpoint port config swagger:model EndpointPortConfig.

EndpointSettings Configuration for a network endpoint.

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

EngineDescription EngineDescription provides information about an engine.

EngineDescriptionPluginsItems0 engine description plugins items0 swagger:model EngineDescriptionPluginsItems0.

ErrorDetail error detail swagger:model ErrorDetail.

ErrorResponse Represents an error.

GenericResourcesItems0 generic resources items0 swagger:model GenericResourcesItems0.

GenericResourcesItems0DiscreteResourceSpec generic resources items0 discrete resource spec swagger:model GenericResourcesItems0DiscreteResourceSpec.

GenericResourcesItems0NamedResourceSpec generic resources items0 named resource spec swagger:model GenericResourcesItems0NamedResourceSpec.

GraphDriverData Information about a container's graph driver.

HealthConfig A test to perform to check that the container is healthy.

HostConfig Container configuration that depends on the host we are running on swagger:model HostConfig.

HostConfigAO1LogConfig The logging configuration for this container swagger:model HostConfigAO1LogConfig.

IDResponse Response to an API call that returns just an Id swagger:model IdResponse.

Image image swagger:model Image.

ImageDeleteResponseItem image delete response item swagger:model ImageDeleteResponseItem.

ImageID Image ID or Digest Example: {"ID":"sha256:85f05633ddc1c50679be2b16a0479ab6f7637f8884e0cfe0f4d20e1ebb3d6e7c"} swagger:model ImageID.

ImageMetadata image metadata swagger:model ImageMetadata.

ImageRootFS image root f s swagger:model ImageRootFS.

ImageSummary image summary swagger:model ImageSummary.

IndexInfo IndexInfo contains information about a registry.

IPAM IP a m swagger:model IPAM.

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

ManagerStatus ManagerStatus represents the status of a manager.

Mount mount swagger:model Mount.

MountBindOptions Optional configuration for the `bind` type.

MountPoint A mount point inside a container swagger:model MountPoint.

MountTmpfsOptions Optional configuration for the `tmpfs` type.

MountVolumeOptions Optional configuration for the `volume` type.

MountVolumeOptionsDriverConfig Map of driver specific options swagger:model MountVolumeOptionsDriverConfig.

Network network Example: {"Attachable":false,"Containers":{"19a4d5d687db25203351ed79d478946f861258f018fe384f229f2efa4b23513c":{"EndpointID":"628cadb8bcb92de107b2a1e516cbffe463e321f548feb37697cce00ad694f21a","IPv4Address":"172.19.0.2/16","IPv6Address":"","MacAddress":"02:42:ac:13:00:02","Name":"test"}},"Created":"2016-10-19T04:33:30.360899459Z","Driver":"bridge","EnableIPv6":false,"IPAM":{"Config":[{"Gateway":"172.19.0.1","Subnet":"172.19.0.0/16"}],"Driver":"default","Options":{"foo":"bar"}},"Id":"7d86d31b1478e7cca9ebed7e73aa0fdeec46c5ca29497431d3007d2d9e15ed99","Ingress":false,"Internal":false,"Labels":{"com.example.some-label":"some-value","com.example.some-other-label":"some-other-value"},"Name":"net01","Options":{"com.docker.network.bridge.default_bridge":"true","com.docker.network.bridge.enable_icc":"true","com.docker.network.bridge.enable_ip_masquerade":"true","com.docker.network.bridge.host_binding_ipv4":"0.0.0.0","com.docker.network.bridge.name":"docker0","com.docker.network.driver.mtu":"1500"},"Scope":"local"} swagger:model Network.

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

NetworkContainer network container swagger:model NetworkContainer.

NetworkSettings NetworkSettings exposes the network settings in the API swagger:model NetworkSettings.

Node node swagger:model Node.

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

NodeSpec node spec Example: {"Availability":"active","Labels":{"foo":"bar"},"Name":"node-name","Role":"manager"} swagger:model NodeSpec.

NodeStatus NodeStatus represents the status of a node.

ObjectVersion The version number of the object such as node, service, etc.

PeerNode Represents a peer-node in the swarm swagger:model PeerNode.

Platform Platform represents the platform (Arch/OS).

Plugin A plugin for the Engine API swagger:model Plugin.

PluginConfig The config of a plugin.

PluginConfigArgs plugin config args swagger:model PluginConfigArgs.

PluginConfigInterface The interface between Docker and the plugin swagger:model PluginConfigInterface.

PluginConfigLinux plugin config linux swagger:model PluginConfigLinux.

PluginConfigNetwork plugin config network swagger:model PluginConfigNetwork.

PluginConfigRootfs plugin config rootfs swagger:model PluginConfigRootfs.

PluginConfigUser plugin config user swagger:model PluginConfigUser.

PluginDevice plugin device swagger:model PluginDevice.

PluginEnv plugin env swagger:model PluginEnv.

PluginInterfaceType plugin interface type swagger:model PluginInterfaceType.

PluginMount plugin mount swagger:model PluginMount.

PluginSettings Settings that can be modified by users.

PluginsInfo Available plugins per type.

Port An open port on a container Example: {"PrivatePort":8080,"PublicPort":80,"Type":"tcp"} swagger:model Port.

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

ProcessConfig process config swagger:model ProcessConfig.

ProgressDetail progress detail swagger:model ProgressDetail.

PushImageInfo push image info swagger:model PushImageInfo.

RegistryServiceConfig RegistryServiceConfig stores daemon registry services configuration.

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

Resources A container's resources (cgroups config, ulimits, etc) swagger:model Resources.

ResourcesBlkioWeightDeviceItems0 resources blkio weight device items0 swagger:model ResourcesBlkioWeightDeviceItems0.

ResourcesUlimitsItems0 resources ulimits items0 swagger:model ResourcesUlimitsItems0.

RestartPolicy The behavior to apply when the container exits.

Runtime Runtime describes an [OCI compliant](https://github.com/opencontainers/runtime-spec) runtime.

Secret secret swagger:model Secret.

SecretSpec secret spec swagger:model SecretSpec.

Service service Example: {"CreatedAt":"2016-06-07T21:05:51.880065305Z","Endpoint":{"Ports":[{"Protocol":"tcp","PublishedPort":30001,"TargetPort":6379}],"Spec":{"Mode":"vip","Ports":[{"Protocol":"tcp","PublishedPort":30001,"TargetPort":6379}]},"VirtualIPs":[{"Addr":"10.255.0.2/16","NetworkID":"4qvuz4ko70xaltuqbt8956gd1"},{"Addr":"10.255.0.3/16","NetworkID":"4qvuz4ko70xaltuqbt8956gd1"}]},"ID":"9mnpnzenvg8p8tdbtq4wvbkcz","Spec":{"EndpointSpec":{"Mode":"vip","Ports":[{"Protocol":"tcp","PublishedPort":30001,"TargetPort":6379}]},"Mode":{"Replicated":{"Replicas":1}},"Name":"hopeful_cori","RollbackConfig":{"Delay":1000000000,"FailureAction":"pause","MaxFailureRatio":0.15,"Monitor":15000000000,"Parallelism":1},"TaskTemplate":{"ContainerSpec":{"Image":"redis"},"ForceUpdate":0,"Placement":{},"Resources":{"Limits":{},"Reservations":{}},"RestartPolicy":{"Condition":"any","MaxAttempts":0}},"UpdateConfig":{"Delay":1000000000,"FailureAction":"pause","MaxFailureRatio":0.15,"Monitor":15000000000,"Parallelism":1}},"UpdatedAt":"2016-06-07T21:07:29.962229872Z","Version":{"Index":19}} swagger:model Service.

ServiceEndpoint service endpoint swagger:model ServiceEndpoint.

ServiceEndpointVirtualIPsItems0 service endpoint virtual i ps items0 swagger:model ServiceEndpointVirtualIPsItems0.

ServiceServiceStatus The status of the service's tasks.

ServiceSpec User modifiable configuration for a service.

ServiceSpecMode Scheduling mode for the service.

ServiceSpecModeReplicated service spec mode replicated swagger:model ServiceSpecModeReplicated.

ServiceSpecRollbackConfig Specification for the rollback strategy of the service.

ServiceSpecUpdateConfig Specification for the update strategy of the service.

ServiceUpdateResponse service update response Example: {"Warning":"unable to pin image doesnotexist:latest to digest: image library/doesnotexist:latest not found"} swagger:model ServiceUpdateResponse.

ServiceUpdateStatus The status of a service update.

Swarm swarm swagger:model Swarm.

SwarmInfo Represents generic information about swarm.

SwarmSpec User modifiable swarm configuration.

SwarmSpecCAConfig CA configuration.

SwarmSpecCAConfigExternalCAsItems0 swarm spec c a config external c as items0 swagger:model SwarmSpecCAConfigExternalCAsItems0.

SwarmSpecDispatcher Dispatcher configuration.

SwarmSpecEncryptionConfig Parameters related to encryption-at-rest.

SwarmSpecOrchestration Orchestration configuration.

SwarmSpecRaft Raft configuration.

SwarmSpecTaskDefaults Defaults for creating tasks in this cluster.

SwarmSpecTaskDefaultsLogDriver The log driver to use for tasks created in the orchestrator if unspecified by a service.

SystemInfo system info swagger:model SystemInfo.

Task task Example: {"AssignedGenericResources":[{"DiscreteResourceSpec":{"Kind":"SSD","Value":3}},{"NamedResourceSpec":{"Kind":"GPU","Value":"UUID1"}},{"NamedResourceSpec":{"Kind":"GPU","Value":"UUID2"}}],"CreatedAt":"2016-06-07T21:07:31.171892745Z","DesiredState":"running","ID":"0kzzo1i0y4jz6027t0k7aezc7","NetworksAttachments":[{"Addresses":["10.255.0.10/16"],"Network":{"CreatedAt":"2016-06-07T20:31:11.912919752Z","DriverState":{"Name":"overlay","Options":{"com.docker.network.driver.overlay.vxlanid_list":"256"}},"ID":"4qvuz4ko70xaltuqbt8956gd1","IPAMOptions":{"Configs":[{"Gateway":"10.255.0.1","Subnet":"10.255.0.0/16"}],"Driver":{"Name":"default"}},"Spec":{"DriverConfiguration":{},"IPAMOptions":{"Configs":[{"Gateway":"10.255.0.1","Subnet":"10.255.0.0/16"}],"Driver":{}},"Labels":{"com.docker.swarm.internal":"true"},"Name":"ingress"},"UpdatedAt":"2016-06-07T21:07:29.955277358Z","Version":{"Index":18}}}],"NodeID":"60gvrl6tm78dmak4yl7srz94v","ServiceID":"9mnpnzenvg8p8tdbtq4wvbkcz","Slot":1,"Spec":{"ContainerSpec":{"Image":"redis"},"Placement":{},"Resources":{"Limits":{},"Reservations":{}},"RestartPolicy":{"Condition":"any","MaxAttempts":0}},"Status":{"ContainerStatus":{"ContainerID":"e5d62702a1b48d01c3e02ca1e0212a250801fa8d67caca0b6f35919ebc12f035","PID":677},"Message":"started","State":"running","Timestamp":"2016-06-07T21:07:31.290032978Z"},"UpdatedAt":"2016-06-07T21:07:31.376370513Z","Version":{"Index":71}} swagger:model Task.

TaskSpec User modifiable task configuration.

TaskSpecContainerSpec Container spec for the service.

TaskSpecContainerSpecConfigsItems0 task spec container spec configs items0 swagger:model TaskSpecContainerSpecConfigsItems0.

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

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

TaskSpecContainerSpecPrivileges Security options for the container swagger:model TaskSpecContainerSpecPrivileges.

TaskSpecContainerSpecPrivilegesCredentialSpec CredentialSpec for managed service account (Windows only) swagger:model TaskSpecContainerSpecPrivilegesCredentialSpec.

TaskSpecContainerSpecPrivilegesSELinuxContext SELinux labels of the container swagger:model TaskSpecContainerSpecPrivilegesSELinuxContext.

TaskSpecContainerSpecSecretsItems0 task spec container spec secrets items0 swagger:model TaskSpecContainerSpecSecretsItems0.

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

TaskSpecLogDriver Specifies the log driver to use for tasks created from this spec.

TaskSpecNetworkAttachmentSpec Read-only spec type for non-swarm containers attached to swarm overlay networks.

TaskSpecPlacement task spec placement swagger:model TaskSpecPlacement.

TaskSpecPlacementPreferencesItems0 task spec placement preferences items0 swagger:model TaskSpecPlacementPreferencesItems0.

TaskSpecPlacementPreferencesItems0Spread task spec placement preferences items0 spread swagger:model TaskSpecPlacementPreferencesItems0Spread.

TaskSpecPluginSpec Plugin spec for the service.

TaskSpecPluginSpecPluginPrivilegeItems0 Describes a permission accepted by the user upon installing the plugin.

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

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

TaskStatus task status swagger:model TaskStatus.

TaskStatusContainerStatus task status container status swagger:model TaskStatusContainerStatus.

ThrottleDevice throttle device swagger:model ThrottleDevice.

TLSInfo Information about the issuer of leaf TLS certificates and the trusted root CA certificate Example: {"CertIssuerPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEmT9XIw9h1qoNclv9VeHmf/Vi6/uI2vFXdBveXTpcPjqx6i9wNazchk1XWV/dKTKvSh9xyGKmiIeRcE4OiMnJ1A==","CertIssuerSubject":"MBMxETAPBgNVBAMTCHN3YXJtLWNh","TrustRoot":"-----BEGIN CERTIFICATE-----\nMIIBajCCARCgAwIBAgIUbYqrLSOSQHoxD8CwG6Bi2PJi9c8wCgYIKoZIzj0EAwIw\nEzERMA8GA1UEAxMIc3dhcm0tY2EwHhcNMTcwNDI0MjE0MzAwWhcNMzcwNDE5MjE0\nMzAwWjATMREwDwYDVQQDEwhzd2FybS1jYTBZMBMGByqGSM49AgEGCCqGSM49AwEH\nA0IABJk/VyMPYdaqDXJb/VXh5n/1Yuv7iNrxV3Qb3l06XD46seovcDWs3IZNV1lf\n3Skyr0ofcchipoiHkXBODojJydSjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMB\nAf8EBTADAQH/MB0GA1UdDgQWBBRUXxuRcnFjDfR/RIAUQab8ZV/n4jAKBggqhkjO\nPQQDAgNIADBFAiAy+JTe6Uc3KyLCMiqGl2GyWGQqQDEcO3/YG36x7om65AIhAJvz\npxv6zFeVEkAEEkqIYi0omA9+CjanB/6Bz4n1uw8H\n-----END CERTIFICATE-----\n"} swagger:model TLSInfo.

Volume volume Example: {"CreatedAt":"2016-06-07T20:31:11.853781916Z","Driver":"custom","Labels":{"com.example.some-label":"some-value","com.example.some-other-label":"some-other-value"},"Mountpoint":"/var/lib/docker/volumes/tardis","Name":"tardis","Scope":"local","Status":{"hello":"world"}} swagger:model Volume.

VolumeUsageData Usage details about the volume.

ContainerSummary container summary swagger:model ContainerSummary.

GenericResources User-defined resources can be either Integer resources (e.g, `SSD=3`) or String resources (e.g, `GPU=UUID1`) Example: [{"DiscreteResourceSpec":{"Kind":"SSD","Value":3}},{"NamedResourceSpec":{"Kind":"GPU","Value":"UUID1"}},{"NamedResourceSpec":{"Kind":"GPU","Value":"UUID2"}}] swagger:model GenericResources.

LocalNodeState Current local status of this node.

NodeState NodeState represents the state of a node.

PortMap PortMap describes the mapping of container ports to host ports, using the container's port-number and protocol as key in the format `<port>/<protocol>`, for example, `80/udp`.

Reachability Reachability represents the reachability of a node.

TaskState task state swagger:model TaskState.