Get a VPN's interfaces

Request

Get the list of interfaces attached to a VPN network on a cluster. Note: NATs within a VPN interface can share the same source and destination CIDRs provided they are differentiated by route metric. This is intentional and not a configuration error.

Security

JWTAuthorizer

Path

clusterFQDNstringrequired

Cluster FQDN

networkNamestringrequired

Network name

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

Responses

OK

Bodyapplication/json

Array [

inDefaultRouteboolean

insideNatsArray of objects

interfaceNamestring

outDefaultRouteboolean

outsideNatsArray of objects

NAT rules for traffic leaving the VPN network (outbound). Maps VPN-side CIDRs to local node CIDRs.

fqdnstring

networkNamestring

]

Response

[
  {
    "inDefaultRoute": true,
    "insideNats": [ … ],
    "interfaceName": "string",
    "outDefaultRoute": true,
    "outsideNats": [ … ],
    "fqdn": "string",
    "networkName": "string"
  }
]