Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Access Points

Get a Swarm details

This API retrieves detailed information about a specific swarm (cluster). It provides comprehensive swarm-related details such as cluster name, conductor information, IP addresses, member count, and software version based on the swarm's cluster ID.

get/network-monitoring/v1/swarms/{cluster-id}

Path parameters

cluster-idstring const required

The unique identifier of the swarm (cluster).

Example:1j4ehold0qj06kpbuy1a89dy5c69xe82ob27givar6mnbq135u

Cluster ID of a swarm (cluster).

Query parameters

site-idstring uuid

Id of a site where devices are associated.

Example:24833497

ID of the Site for which access point related information is requested

Response

Object containing information about the swarm, such as cluster name, siteId, conductor information, IP addresses, member count, and software version.

clusterIdstring const required

The unique identifier of the swarm (cluster).

clusterNamestring const

The name of the cluster to which the device belongs. If the device is not part of any cluster then the cluster name will be null.

siteIdstring const

The unique identifier of the site to which the access point has been assigned.

conductorDeviceNamestring const

The name of the conductor device in the swarm.

conductorSerialNumberstring const

The serial number of the conductor device in the swarm.

ipv4string ipv4

IPv4 address of the access point.

ipv6string ipv6

IPv6 address of the access point.

membersCountinteger

The number of members in the swarm. This field is only available in the swarm detail API, not in the list API.

firmwareVersionstring const

Firmware version currently running on the access point.

publicIpAddressstring ipv4

Public IP address of the swarm.

idstring const required

Primary identifier for the resource.

typestring const required

The type of the resource.

Example response

{
  "clusterId": "1j4ehold0qj06kpbuy1a89dy5c69xe82ob27givar6mnbq135u",
  "clusterName": "Cluster1",
  "siteId": "24833497",
  "conductorDeviceName": "ArubaAP",
  "conductorSerialNumber": "AP00000001",
  "ipv4": "10.2.3.5",
  "ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
  "membersCount": 1,
  "firmwareVersion": "8.9.0.0-8.9.0.0_81161",
  "publicIpAddress": "104.36.250.13",
  "id": "1j4ehold0qj06kpbuy1a89dy5c69xe82ob27givar6mnbq135u",
  "type": "network-monitoring/access-point-monitoring"
}