Skip to content

Measure the node's internet bandwidth to the Trustgrid control plane

Request

Runs a download and/or upload throughput test between the node and the Trustgrid control plane speed-test endpoints. Results stream as JSON objects containing downloadMbps, maxDownloadMbps, uploadMbps, and maxUploadMbps.

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

Requires nodes::service:speed-test 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
actionstring
  • download — test download speed only
  • upload — test upload speed only
  • both — test download then upload
Default:"both"
Enum:"download""upload""both"
curl -i -X POST \
  'https://apidocs.trustgrid.io/_mock/node/{nodeID}/trigger/speed-test?wait=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "action": "download"
  }'

Responses

OK

Bodyapplication/json
boolean
Response
true