v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Gateways

List Gateway ports

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

get/network-monitoring/v1/gateways/{serial-number}/ports

Path parameters

serial-numberstring required

The gateway serial number.

Example:GW00000001

Serial number of the gateway device.

Query parameters

filterstring

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.

sortstring

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.

limitinteger

Example:20

Denotes the maximum number of ports returned in the response.

nextstring

Specifies the pagination cursor for the next page of resources.

Example:1

Specifies the pagination cursor for the next page of resources.

Minimum value: 1

Response

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

countinteger required

The number of items in the response.

totalinteger

Specifies the total number of items available for a given filter query.

nextstring int32 required

Indicates the next page number, or null if there are no further pages.

Example response

{
  "items": [
    {
      "name": "GE 0/0/1",
      "health": "Good",
      "healthReasons": [],
      "portNumber": 0,
      "duplex": "Full",
      "speed": "1000",
      "vlan": "304-310",
      "mtu": 1500,
      "usage": {
        "received": 10000,
        "sent": 3000,
        "total": 13000
      },
      "throughput": {
        "received": 1000,
        "sent": 100
      },
      "totalPackets": 300,
      "broadcastPackets": 50,
      "multicastPackets": 20,
      "crcErrors": 0,
      "collisions": 1,
      "runts": 0,
      "giants": 0,
      "macAddress": "11:22:33:44:55:66",
      "adminState": "Disabled",
      "operState": "Down",
      "portType": "Access",
      "connectorType": "RJ45",
      "id": "GW00000001/ports/GE 0/0/1",
      "type": "network-monitoring/gateway-monitoring"
    }
  ],
  "count": 1,
  "total": 4,
  "next": "2"
}