Swarm

Join an existing swarm

post/swarm/join

Request

Base URL
/v1.49 (relative, and the document was published on a file host, not at the API’s origin)
URL
/v1.49/swarm/join
Auth
none declared

Request body

ListenAddrstring

Listen address used for inter-manager communication if the node gets promoted to manager, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP).

AdvertiseAddrstring

Externally reachable address advertised to other nodes. This can either be an address/port combination in the form 192.168.1.1:4567, or an interface followed by a port number, like eth0:4567. If the port number is omitted, the port number from the listen address is used. If AdvertiseAddr is not specified, it will be automatically detected when possible.

DataPathAddrstring

Address or interface to use for data path traffic (format: <ip|interface>), for example, 192.168.1.1, or an interface, like eth0. If DataPathAddr is unspecified, the same address as AdvertiseAddr is used.

The DataPathAddr specifies the address that global scope network drivers will publish towards other nodes in order to reach the containers running on this node. Using this parameter it is possible to separate the container data traffic from the management traffic of the cluster.

RemoteAddrsstring[]

Addresses of manager nodes already participating in the swarm.

JoinTokenstring

Secret token for joining this swarm.

Example request

{
  "ListenAddr": "0.0.0.0:2377",
  "AdvertiseAddr": "192.168.1.1:2377",
  "DataPathAddr": "192.168.1.1",
  "RemoteAddrs": [
    "node1:2377"
  ],
  "JoinToken": "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2"
}

Response

no error

Changes

No recorded changes to this operation across all 4 revisions of this API.