Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Gateways

Gateway port detail

Retrieves information about a specific port with details like speed, name, MAC address, MTU, status and more.

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

Path parameters

serial-numberstring required

The gateway serial number.

Example:GW00000001

Serial number of the gateway device.

port-numberstring required
Example:2

Port number that represents the physical port of the gateway interface (GE 0/0/{port-number}).

Query parameters

start-atstring date-time

Date-time in RFC 3339 format (ISO 8601) in UTC timezone with milliseconds.

Example:2025-08-06T12:34:56.124Z

When not provided, the response returns the latest statistics. When provided, the response returns aggregated statistics over the specified time range. Aggregation starts from this timestamp, which must be in RFC 3339 (ISO 8601) format in UTC+0 timezone. The difference between end-at and start-at must be less than 30 days.

end-atstring date-time

Date-time in RFC 3339 format (ISO 8601) in UTC timezone with milliseconds.

Example:2025-08-06T12:34:56.124Z

Aggregation is computed up to this timestamp, which must be in RFC 3339 (ISO 8601) format in UTC+0 timezone. The timestamp must be earlier than the current time and later than start-at.

Response

Object containing information about the physical ports in a gateway.

namestring required

Name of the webhook. Must be unique per customer.

health'Good' | 'Fair' | 'Poor' required

The health status of the wired interface.

healthReasonsstring[]
portNumberinteger required

The port number.

duplex'Full' | 'Half' | 'Auto' required

The Duplex of the port.

speedinteger required

The data transmission rate of the port in Mbps.

vlanstring required

The VLAN ID assigned to the port.

mtuinteger required

The MTU value of the port.

totalPacketsinteger required

The total number of packets transferred.

broadcastPacketsinteger required

The total number of broadcast packets transferred.

multicastPacketsinteger required

The total number of multicast packets transferred.

crcErrorsinteger required

The total number of CRC errors detected.

collisionsinteger required

The total number of collisions detected.

runtsinteger required

The total number of runt packets detected.

giantsinteger required

The total number of giant packets detected.

macAddressstring required

The gateway port MAC address.

adminState'Enabled' | 'Disabled' required

The administrative state of the port.

operState'Up' | 'Down' required

The operational state of the port.

portType'Access' | 'Trunk' required

The VLAN mode of the port.

connectorType'RJ45' | 'SFP' required

The type of the port.

idstring required

Primary identifier for the resource.

typestring required

The type of the resource.

Example response

{
  "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"
}