List Gateway ports

get

https://de1.api.central.arubanetworks.com/network-monitoring/v1/gateways/{serial-number}/ports

Retrieves a list of ports present in the gateway with details like speed, name, MAC address, MTU, status and more.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

serial-number

string

required

length ≤ 16

Serial number of the gateway device.

Query Params

filter

string

length ≤ 256

OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.

Field	Operators
`speed`	`eq` and `in`
`duplex`	`eq` and `in`
`vlan`	`eq` and `in`
`macAddress`	`eq` and `in`
`portType`	`eq` and `in`

The operators are implemented as follows:

eq: Only values exactly matching the given value are returned.
in: Only values present in the given list are returned.

sort

string

length ≤ 256

A 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 mtu, speed, duplex and vlan.

limit

int64

0 to 1000

Defaults to 20

Denotes the maximum number of ports returned in the response.

string

Specifies the pagination cursor for the next page of resources.

Minimum value: 1

Responses

200Object containing information about the wired interfaces present in the gateway.

400Bad Request

401Unauthorized request.

403Forbidden: Access is denied.

404Not Found error

429Too Many Requests. Rate limit exceeded.

500Internal server error.