---
title: "Get a list of Swarms"
method: GET
path: "/network-monitoring/v1/swarms"
tags: ["Access Points"]
---

# Get a list of Swarms

`GET /network-monitoring/v1/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.

## Query parameters

- `filter` string, const
- `sort` string, const
- `limit` integer
- `next` string — Specifies the pagination cursor for the next page of resources.

## Response `200`

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

- SwarmListResponse
  - `items` SwarmListInfo[], required
    - `clusterId` string, const, required — The unique identifier of the swarm (cluster).
    - `clusterName` string, 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.
    - `siteId` string, const — The unique identifier of the site to which the access point has been assigned.
    - `siteName` string, const — SiteName represents the name of the site where the device is located. This name is used to identify and manage devices based on their physical location, allowing for better organization and tracking.
    - `conductorDeviceName` string, const — The name of the conductor device in the swarm.
    - `conductorSerialNumber` string, const — The serial number of the conductor device in the swarm.
    - `ipv4` string, ipv4 — IPv4 address of the access point.
    - `ipv6` string, ipv6 — IPv6 address of the access point.
    - `firmwareVersion` string, const — Firmware version currently running on the access point.
    - `publicIpAddress` string, ipv4 — Public IP address of the swarm.
    - `id` string, const, required — Primary identifier for the resource.
    - `type` string, const, required — The type of the resource.
  - `count` integer, required — Number of items in the response.
  - `total` integer — Specifies the total number of items available for a given filter query.
  - `next` string, int32, required — Indicate the next page number, null if there are no further pages.

## Other responses

- `400` — Invalid input received.
- `401` — Unauthorized. Authentication credentials are required or invalid.
- `403` — Forbidden: Access is denied.
- `429` — Too Many Requests. The user has sent too many requests in a given amount of time.
- `500` — Internal Server Error. An unexpected error occurred on the server.

---

[API](https://skmtc.net/arubanetworks/apis/authorization.md) · [All operations](https://skmtc.net/arubanetworks/apis/authorization/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/arubanetworks/authorization/revisions/74c95058b11f/schema)