API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference
GithubAirheads Developer Community

Create profile by name

post
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/speed-test/

A speed test profile defines the parameters for conducting network performance tests,
including endpoints, test duration, and measurement intervals. Each profile is identified
by its unique name. Use these APIs to create, modify, or delete an instance.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 9999

Speed test profile name.

Query Params
string

LOCAL - To create local objects. SHARED - To create shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be created. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be created. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

profilebody object

int64
0 to 4294967295

Speed test bandwidth.

string
length between 1 and 256

Speed test profile description.

boolean
Defaults to false

The direction of traffic is reversed and sent from the server to the client.
This option enables Iperf to run the speed test for an extended duration.

string
length between 1 and 256

Speed test profile name.

int64
1 to 5

Number of initial seconds to omit.

boolean
Defaults to false

Run speed test on boot up.

int64
1 to 30

Number of parallel client streams.

string
enum
Defaults to TCP

Speed test protocol.

Show Details
TCPExecute speed test profile using the TCP protocol
UDPExecute speed test profile using the UDP protocol
Allowed:
string
length ≤ 9999

IP address of the Iperf server which is used to run the speed test.

int32
0 to 65535
Defaults to 5201

Server port that the client needs to connect to execute the speed test.

int64
1 to 20
Defaults to 10

Speed test duration.

int64
60 to 4294967295

Time interval(in seconds) to run the speed test on a regular basis.
The minimum time interval is 60 seconds.

int64
64 to 16384

TCP window size or socket buffer size sent to the server while running speed test.

Responses

Updated 11 days ago

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

Updated 11 days ago