Run a throughput performance test to a peer gateway node

Request

Opens a streaming session that sends a configurable amount of data to the destination node and measures throughput. Progress is streamed as text while the test runs; a summary line with rate in Mbps is emitted at the end.

Use ?wait=1 to block until the test completes and receive the full output.

Requires nodes::service:gateway-perf 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 send data to

Example:"edge-node.example.trustgrid.io"

gwPathstring

Gateway path ID to use. Omit for default path.

bytesinteger

Number of bytes to send

Default:10000000

messageSizeinteger

Size of each message chunk in bytes

Default:50000

windowSizeinteger

Flow-control window size in bytes

Default:1000000

curl -i -X POST \
  'https://apidocs.trustgrid.io/_mock/node/{nodeID}/trigger/gateway-perf?wait=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "dest": "edge-node.example.trustgrid.io",
    "gwPath": "string",
    "bytes": 10000000,
    "messageSize": 50000,
    "windowSize": 1000000
  }'

Responses

OK

Bodyapplication/json

boolean

Response

true