Skip to content

Run an MTR network diagnostic from the node

Request

Starts an interactive MTR (Matt's Traceroute) session to the specified host. Results stream as terminal output.

Use ?wait=1 to block and receive the buffered MTR output.

Requires nodes::service:tg-mtr 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
hostnamestringrequired

Target host IP or hostname

Example:"8.8.8.8"
optionsstring

Additional MTR command-line options (space-separated)

Example:"--report"
colsinteger

Terminal column width for MTR display

Default:80
curl -i -X POST \
  'https://apidocs.trustgrid.io/_mock/node/{nodeID}/trigger/tg-mtr?wait=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "hostname": "8.8.8.8",
    "options": "--report",
    "cols": 80
  }'

Responses

OK

Bodyapplication/json
boolean
Response
true