Logo
Akamai APIs API Documentation

Test network connectivity with MTR

POST https://{{host}}/edge-diagnostics/v1/mtr

Uses MTR to provide information about packet loss and latency between an edge server IP, location, or Site Shield map and a remote destination. To run this operation for an IP, you may need to verify an IP if it belongs to an edge server. To run this operation for a GTM hostname, run List GTM properties and List test and target IPs for a GTM hostname operations first to get the test and target IPs for the hostname.

 

Body PARAM

Key Datatype Required Description 
accountSwitchKey
string (Optional) For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).



HEADERS

Key Datatype Required Description 
Content-Type
string
Accept
string




RESPONSES

status OK

{ "completedTime": "2021-03-19T06:46:08Z", "createdBy": "alfulani", "createdTime": "2021-03-19T06:45:39Z", "destinationIpLocation": { "asNumber": 20005, "city": "TOKYO", "countryCode": "JP", "regionCode": "13" }, "executionStatus": "SUCCESS", "request": { "destination": "192.0.2.0", "destinationType": "IP", "packetType": "ICMP", "port": 80, "resolveDns": true, "showIps": true, "showLocations": true, "source": "192.0.2.9", "sourceType": "EDGE_IP" }, "result": { "averageLatency": 0.5, "hops": [ { "averageLatency": 51.3, "bestRtt": 1.3, "host": "NNN.NNN-NNNN.netarch.akamai.com", "ip": "192.0.2.7", "ipLocation": { "asNumber": 20000, "city": "TOKYO", "countryCode": "JP", "regionCode": "13" }, "lastPacketLatency": 1.3, "number": 1, "packetLoss": 0, "sentPackets": 10, "standardDeviation": 82.4, "worstRtt": 220.1 }, { "averageLatency": 0.5, "bestRtt": 0.5, "host": "NNN-N-NNNNN.net.telefonicaglobalsolutions.com", "ip": "192.0.2.0", "ipLocation": { "asNumber": 20001, "city": "TOKYO", "countryCode": "JP", "regionCode": "13" }, "lastPacketLatency": 2.2, "number": 2, "packetLoss": 0, "sentPackets": 10, "standardDeviation": 3.9, "worstRtt": 11.9 } ], "host": "aNNN-NNN-NNN.deploy.akamaitechnologies.com", "packetLoss": 0, "result": "Start: 2021-03-19T06:45:48+0000\nHOST: aNNN-NNN-NNN.deploy.akamaitechnologies.com Loss% Snt Last Avg Best Wrst StDev\n 1.|-- NNN.NNN-NNNN.netarch.akamai.com (192.0.2.7) 0.0% 10 1.3 51.3 1.3 220.1 82.4\n 2.|-- NNN-N-NNNNN.net.telefonicaglobalsolutions.com (192.0.2.0) 0.0% 10 2.2 3.4 0.5 11.9 3.9", "startTime": 1616136348 }, "sourceInternalIp": "192.0.2.8", "sourceIpLocation": { "asNumber": 20002, "city": "TOKYO", "countryCode": "JP", "regionCode": "13" } }



Curl
curl -X POST 'https://undefined/edge-diagnostics/v1/mtr?accountSwitchKey=' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"destination":"192.0.2.0","destinationType":"IP","packetType":"ICMP","port":80,"resolveDns":true,"showIps":true,"showLocations":true,"source":"192.0.2.9","sourceType":"EDGE_IP"}'

ENDPOINTS