Ping a peer gateway node over the Trustgrid overlay

Request

Sends echo packets to the specified destination node through the Trustgrid gateway overlay and reports round-trip latency. Results stream as JSON objects with RTT measurements.

Use ?wait=1 to block until the session ends and receive buffered output.

Requires nodes::service:gateway-ping 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/jsonrequired

deststringrequired

Destination node FQDN to ping

Example:"gateway.example.trustgrid.io"

gwPathstring

Gateway path ID to use. Omit for default path.

intervalinteger

Interval between echo packets in seconds

Default:5

sizeinteger

Echo payload size in bytes

Default:64

sendJsonboolean

If true, the node accepts JSON-formatted echo data

Default:false

curl -i -X POST \
  'https://apidocs.trustgrid.io/_mock/node/{nodeID}/trigger/gateway-ping?wait=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "dest": "gateway.example.trustgrid.io",
    "gwPath": "string",
    "interval": 5,
    "size": 64,
    "sendJson": false
  }'

Responses

OK

Bodyapplication/json

boolean

Response

true