Skip to content

Retrieve the node's active gateway routing table

Request

Returns the gateway peer routing table showing which nodes the gateway is connected to, their RTT, throughput, and path details.


Requires nodes::service:gateway-routes or nodes::remote-execute permission.

Security
JWTAuthorizer
Path
nodeIDstringrequired

Node ID

Query
waitinteger

Pass 1 to block until the node responds and return its output.

Value:1
Bodyapplication/json
showClusterRoutesboolean

Include cluster-level routes in the output

Default:false
enableLogboolean

Enable debug logging during route collection

Default:true
curl -i -X POST \
  'https://apidocs.trustgrid.io/_mock/node/{nodeID}/trigger/gateway-routes?wait=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "showClusterRoutes": false,
    "enableLog": true
  }'

Responses

OK

Bodyapplication/json
outputobject
Response
{ "output": { "available": 0, "connected": 0, "domains": [] } }