v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Access Points

Get a list of Swarms

This API endpoint retrieves a list of swarms (clusters) associated to a customer, based on the query parameters provided. Each swarm in the returned list includes comprehensive details like cluster ID, cluster name, site ID, conductor information, IP addresses, and software version. The query parameters allow you to narrow down the results to swarms that meet specific criteria, ensuring you receive only the relevant data.

get/network-monitoring/v1/swarms

Query parameters

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
clusterId	eq and in
clusterName	eq and in
conductorSerialNumber	eq and in
conductorDeviceName	eq and in
firmwareVersion	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:clusterName,conductorDeviceName desc

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 clusterId, clusterName, conductorDeviceName, and conductorSerialNumber.

limitinteger

Example:20

Specifies the maximum number of swarms 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.

The minimum value: 1

Response

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

countinteger required

Number of items in the response.

totalinteger

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

nextstring int32 required

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

Example response

{
  "items": [
    {
      "clusterId": "1j4ehold0qj06kpbuy1a89dy5c69xe82ob27givar6mnbq135u",
      "clusterName": "Cluster1",
      "siteId": "24833497",
      "siteName": "site1",
      "conductorDeviceName": "ArubaAP",
      "conductorSerialNumber": "AP00000001",
      "ipv4": "10.2.3.5",
      "ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
      "firmwareVersion": "8.9.0.0-8.9.0.0_81161",
      "publicIpAddress": "104.36.250.13",
      "id": "1j4ehold0qj06kpbuy1a89dy5c69xe82ob27givar6mnbq135u",
      "type": "network-monitoring/access-point-monitoring"
    }
  ],
  "count": 1,
  "total": 6,
  "next": "2"
}