Nodes

Pair a node the control plane can reach: returns the command to run on it. The control plane then dials the node until it answers or the pairing expires (30 minutes).

Changed on
post/nodes/pairings

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/nodes/pairings
  • Auth: HTTP bearer

Request body

addressstring required

The node's public address, ip or ip:port. The control plane dials it on the mesh UDP port (or the port given).

namestring nullable

Name the node registers under. Defaults to worker-<random>.

Response

Pairing created

join_commandstring required

Run this on the node, as root. It pipes the pairing code into temps join --pair -, so the code stays out of the process list and shell history.

Changes