Documentation Index

Fetch the complete documentation index at: https://docs.graphiant.com/llms.txt

Use this file to discover all available pages before exploring further.

/v1/diagnostic/traceroute

Prev Next
Post
/v1/diagnostic/traceroute

Trigger a diagnostic test

Security
API Key: jwtAuth
Header parameter nameauthorization

Use Bearer <token>

Header parameters
Authorization
stringRequired

Bearer token. Format: Bearer <your_token_here>

Body parameters
Expand All
object
deviceId
integer (int64) Required

Valid Provisioned device ID (required)

Minimum0
Example10000000
params
object (diagnosticToolsDiagnosticParams)
destAddress
string Required

IPv4 or IPv6 Destination address (required)

Example172.1.1.1
hopStatsCount
integer (int32)

Per hop probes needed for traceroute hop stats

Minimum0
Example10
interface
string

Source Interface name

Exampleethernet1/0
payloadSize
integer (int32)

Size of packet to be sent

Minimum0
Example64
port
integer (int32) Required

Valid in case of TCP ping (required)

Minimum0
Example443
probeCount
integer (int32)

Number of probes to send

Minimum0
Example4
srcAddress
string Required

IPv4 or IPv6 address (required)

Example10.1.1.1
tos
integer (int32)

Type of service

Minimum0
Example0 - 7
vrfName
string Required

configure VRF Name (required)

Examplefinance
token
string

Identifier which was received in initial response

Exampleexample string
transportType
string Required

ICMP or TCP (required)

ExampleENUM_VALUE
Responses
200

OK

Expand All
object
result
object (diagnosticToolsDiagnosticResult)
pingResult
object (diagnosticToolsPingResult)
avgLoss
number (float)

% loss (required)

Example64.0
avgTime
number (double)

Time in milli seconds (required)

Example3.0
completedTime
object (googleProtobufTimestamp)
nanos
integer (int32)
Example123
seconds
integer (int64)
Example1234567891011
maxTime
number (double)

Time in milli seconds (required)

Example10.0
minTime
number (double)

Time in milli seconds (required)

Example5.0
result
string

Success or Failed (required)

ExampleSuccess
routeInfo
object (diagnosticToolsRouteLookupResult)
nexthopAddress
string

IPv4 or IPv6 gateway address (required)

Example1213:1::6451
outgoingInterface
string

Interface name (required)

ExampleEthernet0/1
prefix
string

IPv4 or IPv6 longest matching prefix (required)

Example1213:1::6451
traceResult
object (diagnosticToolsTracerouteResult)
hops
Array of object (diagnosticToolsHopInfo)
object
hostAddress
string

IPv4 or IPv6 address (required)

Example1213:1::6451
pathMtu
integer (int32)

Path MTU for this host_address (required)

Minimum0
Example1500
roundTripTime
number (double)

time in milli seconds (required)

Example10.0
stats
object (diagnosticToolsHopStats)
avgTime
number (double)

Time in milli seconds (required)

Example3.0
maxTime
number (double)

Time in milli seconds (required)

Example10.0
minTime
number (double)

Time in milli seconds (required)

Example5.0
rxPackets
integer (int32)

Received packet count (required)

Minimum0
Example10
stdDevTime
number (double)

Standard deviation of the round-trip time in milli seconds (required)

Example3.0
txPackets
integer (int32)

Transmitted packet count (required)

Minimum0
Example10
maxLatency
number (double)

time in milliseconds (required)

Example10.0
maxLatencyHost
string

IPv4 or IPv6 address (required)

ExampleA123:3242::1111
maxPathMtu
integer (int32)

Path MTU (required)

Minimum0
Example1500
minPathMtu
integer (int32)

Path MTU (required)

Minimum0
Example1000
result
string

Success or Failed (required)

ExampleFailed
stoppedTime
object (googleProtobufTimestamp)
nanos
integer (int32)
Example123
seconds
integer (int64)
Example1234567891011
token
string

Token to be sent in subsequent lookup (required)

Exampleexample string