Skip to content

Get a VPN's services

Request

Requires node-vpn::read permission.

Security
JWTAuthorizer
Path
nodeIDstringrequired

Node ID

networkNamestringrequired

Network name

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

Responses

OK

Bodyapplication/json
Array [
ipstring
namestring
portnumber
networkNamestring

Name of the VPN network this service belongs to

nodeUidstring

UUID of the node that owns this service

uidstring

Unique identifier for this service

typestring

Record type discriminator, always "Service"

Value:"Service"
]
Response
[
  {
    "ip": "string",
    "name": "string",
    "port": 0,
    "networkName": "string",
    "nodeUid": "string",
    "uid": "string",
    "type": "Service"
  }
]