Gateways

Create a gateway

post
Authorizations
Path parameters
networkstringRequired

Network ID

nodeidstringRequired

Node ID

Body
extclientdnsstringOptional
inet_node_client_idsstring[]Optional
is_internet_gwbooleanOptional
metadatastringOptional
mtuintegerOptional
netidstringOptional
nodeidstringOptional
persistentkeepaliveintegerOptional
relayaddrsstring[]Optional
Responses
post
/api/nodes/{network}/{nodeid}/gateway

Delete a gateway

delete
Authorizations
Path parameters
networkstringRequired

Network ID

nodeidstringRequired

Node ID

Responses
delete
/api/nodes/{network}/{nodeid}/gateway

Assign a node to a gateway

post
Authorizations
Path parameters
networkstringRequired

Network ID

nodeidstringRequired

Client node ID to assign to gateway

Query parameters
gw_idstringRequired

Gateway node ID

auto_assign_gwbooleanOptional

Enable auto-assign gateway (Pro only)

Responses
post
/api/nodes/{network}/{nodeid}/gateway/assign

Unassign client nodes from a gateway

post
Authorizations
Path parameters
networkstringRequired

Network ID

nodeidstringRequired

Node ID

Responses
post
/api/nodes/{network}/{nodeid}/gateway/unassign

Last updated

Was this helpful?