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/speedtest

Prev Next
Post
/v1/diagnostic/speedtest

Trigger Speedtest utility

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

Unique identifier for a specific device (required)

Minimum0
Example30000000555
params
object (diagnosticToolsSpeedtestParams)
provider
string Required

Speedtest provider name (required)

Exampleookla
serverId
string

This is fetched using GetSpeedtestServers API

Example234123
target
object (diagnosticToolsTargetType) Required
interface
string

Source Interface name

Exampleethernet1/0
vrfName
string

Configured VRF Name

Exampleisp-red
token
string

Token to be sent in subsequent lookup

Exampleexample string
Responses
200

OK

Expand All
object
result
object (diagnosticToolsSpeedtestResult)
avgPingTime
number (double)

Avg Ping Time in milli seconds (required)

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

Download speed in Mbps (required)

Example30.1
isp
string

ISP details (required)

ExampleGoogle Fiber
maxPingTime
number (double)

Max PingTime in milli seconds (required)

Example5.0
minPingTime
number (double)

Min Ping Time in milli seconds (required)

Example10.0
result
string

Status of the speedtest operation (required)

ExampleFailed
serverDetails
object (diagnosticToolsSpeedtestServer)
country
string

Country of the speedtest server (required)

ExampleUnited Kingdom
host
string

Hostname of the speedtest server (required)

Examplespeedtest.fastmetrics.com
id
string

Server Id. Internal mapping to a server.

Example29113
ipAddress
string

IPv4 or IPv6 address (required)

Example1213:1::6451
location
string

Location of the speedtest server (required)

ExampleSheffield
name
string

Name of the speedtest server (required)

ExampleGoogle Fiber
uploadSpeed
number (double)

Upload speed in Mbps (required)

Example21.0
token
string

Token to be sent in subsequent lookup (required)

Exampleexample string