HomeGuidesAPI Reference
API Reference

Start a bidirectional link integrity test between two appliances

Initiates a bidirectional link integrity test between two appliances using iperf or tcpperf. The test runs in both directions sequentially: first from appliance A (server) to appliance B (client), then reversed. Only one test can run at a time across the system.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Configuration for the link integrity test including appliance pairs, test parameters, and network path settings.

Request body for starting a link integrity test. The request uses dynamic property names where each nePk value in the array must have a corresponding configuration object.

nePks
array of objects
required

List of appliance identifiers (nePks).

nePks*
string
enum
required

DSCP marking for test traffic. Use 'any' for no specific marking, named values (be, cs1-cs7, af11-af43, ef), or numeric 0-63.

string
required
^[0-9]+$

Test duration per direction in seconds. Minimum 10, maximum 1000000. Default is 10 if not specified.

string
enum
required

Test program to use. 'iperf' for standard bandwidth testing, 'tcpperf' for TCP performance testing with optional custom parameters.

Allowed:
string

Additional command-line parameters for tcpperf only. Ignored for iperf tests.

Responses

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