v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Access Points

Initiate a Speedtest on an AP

Starts an asynchronous Speedtest on the specified AP.

post/network-troubleshooting/v1/aps/{serial-number}/speedtest

Path parameters

serial-numberstring required

Serial number of the target device

Request body

iperfServerAddressstring required

IP Address Required

protocol'tcp' | 'udp'
serverPortinteger

Enter number between (0-65535)

bandwidthinteger

Configures the bandwidth length in Kbps

includeReverseboolean

Reverse

secondsToMeasureinteger

Configures a time duration (in seconds) to run the speed test

parallelinteger
omitinteger

Enter the number of initial seconds to omit.

windowSizeinteger

Window size (in kb) sent to the server while running speed test

Response

Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status.

locationstring uri-reference

The relative URL path to query the status and result of the asynchronous operation.

status'INITIATED'

The initial status of the operation.

startTimestring date-time

ISO 8601 timestamp indicating when the operation was initiated.