---
title: "Get a Swarm details"
method: GET
path: "/network-monitoring/v1/swarms/{cluster-id}"
tags: ["Access Points"]
---

# Get a Swarm details

`GET /network-monitoring/v1/swarms/{cluster-id}`

## Request

- Base URL: `https://sso.common.cloud.hpe.com`
- URL: `https://sso.common.cloud.hpe.com/network-monitoring/v1/swarms/{cluster-id}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://sso.common.cloud.hpe.com/as/token.oauth2`
- TypeScript: <https://skmtc.dev/arubanetworks/apis/authorization/docs/network-monitoring/v1/swarms/:cluster-id/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Path parameters

- `cluster-id` string, const, required: The unique identifier of the swarm (cluster).

## Query parameters

- `site-id` string, uuid: Id of a site where devices are associated.

## Response `200`

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

- SwarmInfo
  - `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.
  - `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.
  - `membersCount` integer: The number of members in the swarm. This field is only available in the swarm detail API, not in the list API.
  - `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.

## Other responses

- `400`: Invalid input received.
- `401`: Unauthorized. Authentication credentials are required or invalid.
- `403`: Forbidden: Access is denied.
- `404`: Swarm Not Found error
- `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.dev/arubanetworks/apis/authorization.md) - [All operations](https://skmtc.dev/arubanetworks/apis/authorization/llms.txt) - [OpenAPI document](https://skmtc.dev/arubanetworks/apis/authorization/revisions/74c95058b11f?raw)