HomeGuidesAPI ReferenceGuidesMRT APIConfiguration API
GitHubAirheads Developer Community
API Reference

Returns interface details for the given serial or stack id.

(Deprecated) This API lists the interfaces for a serial or stack id for a specific site. Conductor serial may also be used instead of a stack id

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

Serial number of an access point device.

Query Params
string
length ≤ 128

ID of the site for which switch-related information is requested.

string
length ≤ 32

The current system time is used by default, even if a value is provided.

string
enum

Deployment type of the switch, STANDALONE in case of standalone switch and STACK in case of stack switch.

Allowed:
int32
0 to 1000
Defaults to 1000

Denotes the number of interfaces that needs to be fetched. Fetches all by default.

int32
Defaults to 0

Denotes the offset from where the interfaces need to be fetched or the number of interfaces to skip.

string
length ≤ 256

OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields are name, speed, status, connector, duplex, lag, vlanmode, neighbour family/function, poeClass, poeStatus and operStatus.

string
length ≤ 256

Partial or full string free text search.

string
length ≤ 256

Comma separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).

The first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.

Supported fields are port, speed, neighbour, neighbourFamily, nativeVlan, neighbourRole, alias, connector, lag, vlanMode, poeClass, ipv4 and mtu. Default sort by name.

Responses

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