Get full details of a VPN network on a node, including routes, services, interfaces, DNS, and WireGuard config

Request

Security

JWTAuthorizer

Path

nodeIDstringrequired

Node ID

networkNamestringrequired

Network name

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

Responses

OK

Bodyapplication/json

networkNamestring

Name of the VPN network

ipstring

IP address assigned to this node within the VPN network

Example:"172.16.101.201"

routestring

CIDR of the VPN network's address space

Example:"172.16.101.0/24"

dnsobject(VpnNodeDnsModel)

exportRoutesArray of objects(VpnNodeRouteModel)

Dynamic export routes advertised by this node into the VPN

importRoutesArray of objects(VpnNodeRouteModel)

Dynamic import routes received by this node from the VPN

interfacesArray of objects(VpnNodeInterfaceModel)

Physical or virtual interfaces bound to this VPN network with NAT rules

routesArray of objects(VpnNodeRouteModel)

Static routes published by this node into the VPN network

servicesArray of objects(VpnNodeServiceModel)

L4 services exposed by this node on the VPN network

wireguardobject

WireGuard tunnel configuration for this VPN network attachment

Response

{
  "networkName": "string",
  "ip": "172.16.101.201",
  "route": "172.16.101.0/24",
  "dns": {
    "enabled": true,
    "upstream": [ … ],
    "networkName": "string",
    "nodeUid": "string"
  },
  "exportRoutes": [
    { … }
  ],
  "importRoutes": [
    { … }
  ],
  "interfaces": [
    { … }
  ],
  "routes": [
    { … }
  ],
  "services": [
    { … }
  ],
  "wireguard": {
    "enabled": true,
    "port": 0,
    "forwarding": true,
    "clients": [ … ]
  }
}