Nodes

The compute pool, whether it can change and what uses it, and each member's cross-node overlay state.

Changed on
get/settings/cluster-network

Request

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

Response

Cluster network

can_changeboolean required

Whether PUT can change the pool now.

change_blocked_bystring[] required

Why it cannot: the members using the pool, or a control-plane setup in progress.

compute_pool_cidrstring required
default_compute_pool_cidrstring required

What a new cluster starts with.

mesh_enabledboolean required
mesh_pool_cidrstring required

The WireGuard mesh pool; a compute pool may not overlap it.

pool_confirmedboolean required

Whether an operator has confirmed the pool, or a member already uses it. The console asks for it once before adding the first node.

subnet_prefix_leninteger required

Changes