Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Gateways

Gateway Details

Retrieves detailed information about a specific gateway including macAddress, deviceName, status and more.

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

Path parameters

serial-numberstring required

The gateway serial number.

Example:GW00000001

Serial number of the gateway device.

Response

Object containing information about the gateway, such as MAC address, name, status, uplinks, ports, and VLANs.

serialNumberstring required

The gateway serial number.

macAddressstring required

The gateway MAC address.

deviceNamestring required

The gateway name.

cpuUtilizationnumber float required

The latest CPU utilization of the gateway.

memoryUtilizationnumber float required

The latest memory utilization of the gateway.

siteIdstring required
firmwareVersionstring required

Firmware version currently running on the gateway.

ipAddressstring ipv4 required

IP address of the VLAN.

uptimeInMillisnumber double required

Elapsed time in milliseconds since the gateway's last boot. This value will be null if the gateway is offline.

macRangestring required

The MAC address range allocated to the gateway.

rebootReasonstring required

The last reboot reason of the gateway.

deviceFunction'Unspecified' | 'Mobility Controller' | 'Branch Gateway' | 'VPNC' required

Device function (Persona identifier) for the gateway.

mode'Standalone' | 'Cluster' required

The operating mode of the gateway.

status'Online' | 'Offline' required

The status of the gateway, either Online or Offline.

role'Isoleader' | 'Leader' | 'Member' required

Role of the gateway in the gateway cluster.

modelstring required

The gateway model.

siteNamestring required

The site to which the gateway is assigned.

clusterNamestring required

The cluster to which the gateway belongs.

idstring required

Primary identifier for the resource.

typestring required

The type of the resource.

Example response

{
  "serialNumber": "GW00000001",
  "macAddress": "11:22:33:44:55:66",
  "deviceName": "gw_1",
  "cpuUtilization": 32,
  "memoryUtilization": 45,
  "siteId": "24833497",
  "firmwareVersion": "8.5.2.0_59123",
  "ipAddress": "198.51.100.42",
  "uptimeInMillis": 1702794777,
  "macRange": "20:4c:03:14:03:7c-20:4c:03:14:03:9b",
  "rebootReason": "Nanny rebooted machine - low on free memory",
  "deviceFunction": "VPNC",
  "mode": "Cluster",
  "status": "Online",
  "role": "Isoleader",
  "model": "Aruba 7005",
  "siteName": "site_1",
  "clusterName": "gateway-cluster-1",
  "id": "GW00000001",
  "type": "network-monitoring/gateway-monitoring"
}