v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Switch

Get a list of Switches

This API endpoint retrieves a list of switches associated to a customer, based on the query parameters provided. Each switch in the returned list includes comprehensive details like serial number, name, MAC address, siteId, status etc.

get/network-monitoring/v1/switches

Query parameters

limitinteger

Example:20

Denotes the maximum number of switches returned in the response.

nextstring int32

Specifies the pagination cursor for the next page of resources.

Example:2

Specifies the pagination cursor for the next page of resources.

Minimum value: 1

filterstring const

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
siteName	eq and in
model	eq and in
status	eq and in
deployment	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 const

Example:deviceName,deployment desc

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, then the default direction is ascending.

Supported fields are siteId, model, status, deployment, serialNumber, and deviceName.

Response

Object containing list of switches.

countinteger required

The number of objects returned in the current list.

totalinteger required

The total number of objects contained in the datastore.

nextstring int32 required

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

Example response

{
  "items": [
    {
      "firmwareVersion": "WC.16.11.0021",
      "ipv4": "10.97.64.183",
      "ipv6": null,
      "lastSeenAt": "2025-12-02T08:52:14.738Z",
      "siteName": "PVOS_MON_Troubleshooting",
      "switchRole": "Conductor",
      "deployment": "Stack",
      "deviceFunction": "None",
      "type": "network-monitoring/switch-monitoring",
      "macAddress": "ec:50:aa:0f:5d:14",
      "publicIp": "61.246.230.194",
      "id": "CN35HKZ1YX",
      "deviceName": "Aruba-VSF-2930F",
      "serialNumber": "CN35HKZ1YX",
      "model": "AS-2930F",
      "siteId": "33453933085143040",
      "partNumber": "JL258A",
      "status": "OFFLINE",
      "uptimeInMillis": 0,
      "stackId": "090064e8-818ee000",
      "stackMemberId": 2,
      "switchType": "pvos",
      "switchTrends": [
        {
          "cpuUtilization": 2,
          "memoryUtilization": 31,
          "poeAvailable": 136,
          "poeConsumption": 0,
          "powerConsumption": 0,
          "serial": "CN05HKZ1BW",
          "switchRole": null,
          "systemTemperature": 0,
          "totalPowerConsumption": 0,
          "upLinkPorts": "1/8",
          "usage": 14345
        }
      ]
    }
  ],
  "count": 1,
  "total": 4,
  "next": "2"
}