Skip to content

List a network's port forwardings

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}/port-forwarding' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
Array [
uidstring

Unique identifier (UUID)

serviceNamestring

Name of the service being forwarded

nodeNamestring

Name of the node receiving forwarded traffic

ipstring

Node IP address traffic is forwarded to

portinteger

Port number traffic is forwarded to

networkNamestring

Virtual network this rule belongs to

domainNamestring

Domain this rule belongs to

orgIdstring

Organization ID

typestring

Object type discriminator

Example:"PortForward"
]
Response
[
  {
    "uid": "string",
    "serviceName": "string",
    "nodeName": "string",
    "ip": "string",
    "port": 0,
    "networkName": "string",
    "domainName": "string",
    "orgId": "string",
    "type": "PortForward"
  }
]