Skip to content

Route

Static routes within a virtual network directing traffic between nodes and subnets. Requires virtual-networks::read to view, virtual-networks::modify to manage.

Get default global vpn routes for a virtual network

Request

Requires virtual-networks::read permission.

Security
JWTAuthorizer
Path
networkNamestringrequired

Network name

domainNamestringrequired

Domain name

curl -i -X GET \
  'https://apidocs.trustgrid.io/_mock/v2/domain/{domainName}/network/{networkName}/route' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
Array [
descriptionstring
domainNamestring
metricnumber
networkCidrstring
networkNamestring
nodeNamestring
uidstring
monitorsArray of objects(VirtualNetworkRouteMonitor)
]
Response
[ { "description": "string", "domainName": "string", "metric": 0, "networkCidr": "string", "networkName": "string", "nodeName": "string", "uid": "string", "monitors": [] } ]