v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Gateways

List Gateways

Retrieves a list of gateways with details like serialNumber, deviceName, macAddress, siteId, status and more. The query parameters allow you to narrow down the results to gateways that meet specific criteria, ensuring you receive only the relevant data.

get/network-monitoring/v1/gateways

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
siteId	eq and in
model	eq and in
status	eq and in
deployment	eq and in
macAddress	eq and in
siteName	eq and in
deviceName	eq and in
firmwareVersion	eq and in
serialNumber	eq and in
clusterName	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 siteId, model, status, deployment, serialNumber, deviceName, macAddress, siteName and firmwareVersion.

limitinteger

Example:20

Denotes the maximum number of gateways 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

List of Gateways, along with their details and associated pagination information.

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": [
    {
      "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"
    }
  ],
  "count": 1,
  "total": 4,
  "next": "2"
}