Join an existing swarm

curl --location --request POST '/v1.33/swarm/join' \ --header 'Content-Type: application/json' \ --data-raw '{ "AdvertiseAddr": "192.168.1.1:2377", "JoinToken": "SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2", "ListenAddr": "0.0.0.0:2377", "RemoteAddrs": [ "node1:2377" ] }'

Request

Body Params application/json

AdvertiseAddr

string

optional

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.

DataPathAddr

string

optional

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.

JoinToken

string

optional

Secret token for joining this swarm.

ListenAddr

string

optional

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).

RemoteAddrs

string

optional

Addresses of manager nodes already participating in the swarm.

Examples

Request

Responses