HomeGuidesAPI ReferenceChangelog
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Get interface overlay transport time series stats data of a single appliance filter by certain query parameters.

This operation returns a JSON object containing data objects of each interface overlay transport is an array, each data object contains the stats for a particular timestamp.

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

Internal ID of the appliance to filter from

integer
required

Long(Signed 64 bits) value of seconds since EPOCH time indicating the starting time boundary of data time range

integer
required

Long(Signed 64 bits) value of seconds since EPOCH time indicating the ending time boundary of data time range

string
enum
required

Data granularity filtering whether data is minutely data, hourly data or daily data.

Allowed:
string

When it is '0',return all physical tunnels;when it is not given,return all bonded and physical tunnels;otherwise,return bonded tunnels associated with the overlay id.

integer
enum

Possible Tunnel type values for overlays are : 0 – SD-WAN, 2 – Breakout, 3 – Services. And Possible Tunnel type values for underlays are: 1 - Underlay, 2 – Pass through, 3 – Services.

Allowed:
integer

Label internal id

boolean

Get WAN side data (true) or LAN side data (false)

string

Interface name

integer

Limit the number of stats entity retrieved. Default and maximum limits are both 10000.

Response

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