Nodes

Turn on the cluster's WireGuard mesh (idempotent). The running control plane brings its end up within a minute and nodes follow; it cannot be turned off again from the API.

Changed on
post/nodes/wireguard

Request

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

Request body

cidrstring nullable

Mesh address pool (private IPv4, clear of the compute pool).

listen_portinteger nullable

UDP port the mesh listens on.

node_api_portinteger nullable

TCP port nodes reach the control plane's API on over the mesh. Defaults to the mesh port number.

Response

Mesh enabled; current state

can_enableboolean required

Whether POST /nodes/wireguard can turn the mesh on here.

cidrstring nullable

Mesh address pool, when enabled.

enable_blockerstring nullable

What prevents enabling it, when can_enable is false and the mesh is off. Rendered verbatim.

enable_commandstring required

CLI equivalent of enabling, for the control-plane host.

handshake_errorstring nullable

Why handshake data is missing, when it is.

join_urlstring nullable

The configured external URL: what temps join should point at. null when none is configured.

listen_portinteger required

UDP port every node must accept from the others — the configured one even while the mesh is off, so it can be opened in advance.

reasonstring nullable

Why the mesh is not ready, when it is not. Rendered verbatim.

state'disabled' | 'starting' | 'ready' required

Whether the cluster's mesh is carrying traffic.

Changes