Skip to content

Get full details of a VPN network on a cluster, including routes, services, interfaces, and DNS

Request

Security
JWTAuthorizer
Path
clusterFQDNstringrequired

Cluster FQDN

networkNamestringrequired

Network name

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

Responses

OK

Bodyapplication/json
dnsobject(VpnClusterDnsModel)
exportRoutesArray of objects(VpnNodeRouteModel)
importRoutesArray of objects(VpnNodeRouteModel)
interfacesArray of objects(VpnClusterInterfaceModel)
routestring
routesArray of objects(VpnClusterRouteModel)
servicesArray of objects(VpnClusterServiceModel)
Response
{
  "dns": {
    "enabled": true,
    "upstream": [ … ],
    "fqdn": "string",
    "networkName": "string"
  },
  "exportRoutes": [
    { … }
  ],
  "importRoutes": [
    { … }
  ],
  "interfaces": [
    { … }
  ],
  "route": "string",
  "routes": [
    { … }
  ],
  "services": [
    { … }
  ]
}