Skip to content

VPN

Per-appliance attachment to virtual networks. Configure which virtual networks an appliance participates in and its VPN interface settings. Requires node-vpn::read permission.

Operations

List all VPN networks attached to a node, including IP assignments and routing

Request

Security
JWTAuthorizer
Path
nodeIDstringrequired

Node ID

curl -i -X GET \
  'https://apidocs.trustgrid.io/_mock/v2/node/{nodeID}/vpn' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
Array [
ipstring
namestring
routestring
idinteger

Numeric identifier for this node-network attachment

networkNamestring

Name of the VPN network

nodeUidstring

UUID of the node this network is attached to

]
Response
[
  {
    "ip": "string",
    "name": "string",
    "route": "string",
    "id": 0,
    "networkName": "string",
    "nodeUid": "string"
  }
]