API

Test network connectivity with MTR

post
https://{hostname}/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.

Query Params
string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Collects data to use in MTR. Objects created for an IP address or a hostname differ from these created for a GTM hostname in terms of included data.

string
required
length ≥ 1

MTR destination compliant with the destinationType, either a hostname or a destination IP. To build an object for a GTM hostname, enter the target value returned by the List test and target IPs for a GTM hostname operation. For a Site Shield hostname, enter a destination IP address.

string
enum
required

Type of destination input, either IP or HOST. To build an object for a GTM or Site Shield hostname, choose IP.

Allowed:
string
enum
required

Packet type used by MTR, either ICMP or TCP.

Allowed:
integer
enum

Port to use to run MTR, either 80 or 443. Provide it only for destinationType set to HOST.

Allowed:
boolean

Resolves DNS for each hop.

boolean

Shows IPs for each hop.

boolean

Shows locations for each hop.

string

Site Shield hostname you want to run the MTR for. To learn more, see Site Shield requests.

string
length ≥ 1

MTR source compliant with the sourceType, either an edge server IP or a location. For locations, enter edgeLocationId for an edge server location closest to your end users. To get this value, run the List available edge server locations operation first. For edge IPs, use the edge server IP value from the answerSection array in the Get domain details with dig operation response. To build an object for a GTM hostname, enter the testIp value returned by the List test and target IPs for a GTM hostname operation.

string
enum

Type of the source input, either EDGE_IP or LOCATION. To build an object for a GTM hostname, choose EDGE_IP.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 4 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 4 months ago