Skip to content

Configure node as a network gateway for routing traffic between networks

Request

Update gateway configuration

Use host (not ip) for the gateway hostname.

Requires nodes::configure:gateway permission.

Security
JWTAuthorizer
Path
nodeIDstringrequired

Node ID

Bodyapplication/json

Gateway config

certstring

Certificate

Example:"mygateway.trustgrid.io"
clientsArray of objects
connectToPublicboolean

Connect to public

enabledbooleanrequired

Enable gateway plugin

hoststring

Hostname of the gateway

Example:"mygateway.trustgrid.io"
maxClientWriteMbpsnumber

Max egress MBPS

Example:1000
maxmbpsnumber

Max ingress MBPS

Example:1000
monitorHopsboolean

Monitor hops

portnumber

Port of the gateway

Example:8080
typestring

Type of gateway

Enum:"private""public""hub"
udpEnabledboolean

Enable UDP

udpPortnumber

UDP port

Example:8081
curl -i -X PUT \
  'https://apidocs.trustgrid.io/_mock/node/{nodeID}/config/gateway' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "cert": "mygateway.trustgrid.io",
    "clients": [
      {
        "enabled": true,
        "name": "mynode"
      }
    ],
    "connectToPublic": true,
    "enabled": true,
    "host": "mygateway.trustgrid.io",
    "maxClientWriteMbps": 1000,
    "maxmbps": 1000,
    "monitorHops": true,
    "port": 8080,
    "type": "private",
    "udpEnabled": true,
    "udpPort": 8081
  }'

Responses

OK

Response
No content