Get traceroute details

GET 
/adem/telemetry/v2/measure/route/hops

Retrieves application path trace details for a specific point in time

Request

Query Parameters

start int64

Possible values: <= 2147483648

The start time of the time range for which you want to retrieve the metrics. Specify in UNIX_TIMESTAMP_SECONDS, for example 1646252520

end int64

Possible values: <= 2147483648

The end time of the time range for which you want to retrieve the metrics. Specify in UNIX_TIMESTAMP_SECONDS, for example 1646263320

timerange string

Timerange over which you want to retrieve metrics, provided in readable format:

last__<minute|hour|day|week|month>

The responses are aggregated over a sample period which is a function of the time interval requested, such that the granularity decreases with increasing interval. See About Autonomous DEM API Timerange Parameter for details.

truncate-timerange boolean

Default value: true

filter string

Selects which fields to include in the query. Must use the format fieldvalue.
The following operators are supported: >=, <=, ==, !=, >, < See About Autonomous DEM API Filter Parameter for details.

endpoint-type stringrequired

Possible values: [muAgent, muProbe, rnAgent, rnProbe]

Selects the endpoint type. See About Autonomous DEM API Endpoint-type Parameter for details.

Header Parameters

Prisma-Tenant stringrequired

Used to specify a specific tenant.

Prisma-SubTenant string

This is an optional parameter. Specifies a sub-tenant of the Prisma-Tenant, if any.

Responses

200

Traceroute summary for overlay and underlay paths

application/json

Schema

Schema

endTime number

sample end time (Unix timestamp)

endpointType string

endpoint type : muAgent, muProbe, rnAgent, rnProbe

pagination object

enabled boolean

limit number

page limit

page number

page number

sortBy string

sort by field

sortOrder string

sort order : asc, desc

rowCount number
startTime number

sample start time (Unix timestamp)

tenantServiceGroup string

array of tenant service groups

vpnOverlayPaths object[]
Array [
endpoint stringrequired
endpoint uuid
hops object[]
Array [
address stringrequired
hop IPv4 address
asn numberrequired
hop ASN
asnName stringrequired
hop ASN ORG
city stringrequired
hop city e.g Incheon
country stringrequired
hop country code e.g KR
dscp numberrequired
DSCP
hop numberrequired
hop index e.g first hop is 1
jitterAvg numberrequired
average jitter, microseconds
loss numberrequired
hop ICMP loss
mpls stringrequired
MPLS
rdns stringrequired
hop hostname
rttAvg numberrequired
average round trip time, microseconds
sent numberrequired
ICMP packets sent
]
id objectrequired
target stringrequired
target
targetAddress stringrequired
target IPv4 address
tunnelIpv4 stringrequired
tunnel IPv4 address
]
vpnUnderlayPaths object[]
Array [
endpoint stringrequired
endpoint uuid
hops object[]
Array [
address stringrequired
hop IPv4 address
asn numberrequired
hop ASN
asnName stringrequired
hop ASN ORG
city stringrequired
hop city e.g Incheon
country stringrequired
hop country code e.g KR
dscp numberrequired
DSCP
hop numberrequired
hop index e.g first hop is 1
jitterAvg numberrequired
average jitter, microseconds
loss numberrequired
hop ICMP loss
mpls stringrequired
MPLS
rdns stringrequired
hop hostname
rttAvg numberrequired
average round trip time, microseconds
sent numberrequired
ICMP packets sent
]
id objectrequired
target stringrequired
target
targetAddress stringrequired
target IPv4 address
tunnelIpv4 stringrequired
tunnel IPv4 address
]

Example (from schema)

{
  "endTime": 0,
  "endpointType": "string",
  "pagination": {
    "enabled": true,
    "limit": 0,
    "page": 0,
    "sortBy": "string",
    "sortOrder": "string"
  },
  "rowCount": 0,
  "startTime": 0,
  "tenantServiceGroup": "string",
  "vpnOverlayPaths": [
    {
      "endpoint": "string",
      "hops": [
        {
          "address": "string",
          "asn": 0,
          "asnName": "string",
          "city": "string",
          "country": "string",
          "dscp": 0,
          "hop": 0,
          "jitterAvg": 0,
          "loss": 0,
          "mpls": "string",
          "rdns": "string",
          "rttAvg": 0,
          "sent": 0
        }
      ],
      "id": {},
      "target": "string",
      "targetAddress": "string",
      "tunnelIpv4": "string"
    }
  ],
  "vpnUnderlayPaths": [
    {
      "endpoint": "string",
      "hops": [
        {
          "address": "string",
          "asn": 0,
          "asnName": "string",
          "city": "string",
          "country": "string",
          "dscp": 0,
          "hop": 0,
          "jitterAvg": 0,
          "loss": 0,
          "mpls": "string",
          "rdns": "string",
          "rttAvg": 0,
          "sent": 0
        }
      ],
      "id": {},
      "target": "string",
      "targetAddress": "string",
      "tunnelIpv4": "string"
    }
  ]
}

400

Invalid Request

401

Invalid Client

500

Server Error

Loading...