---
title: "List Gateway Cluster members"
method: GET
path: "/network-monitoring/v1/clusters/{cluster-name}/members"
tags: ["Gateways"]
---

# List Gateway Cluster members

`GET /network-monitoring/v1/clusters/{cluster-name}/members`

## Request

- Base URL: `https://sso.common.cloud.hpe.com`
- URL: `https://sso.common.cloud.hpe.com/network-monitoring/v1/clusters/{cluster-name}/members`
- 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/clusters/:cluster-name/members/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a list of gateways present in a cluster with comprehensive details.

## Path parameters

- `cluster-name` string, const, required: 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.

## Query parameters

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

## Response `200`

Object containing information about the gateways present in the cluster.

- ClusterMemberListResponse
  - `items` object[], required
    - `clusterName` string, required: The cluster to which the gateway belongs.
    - `ipv4` string, ipv4, required: IP address of the VLAN.
    - `ipv6` string, ipv6, required: IPv6 address of the gateway.
    - `lastSeenAt` string, date-time, required: An RFC 3339 date-time indicating the last detected time of the gateway in the system. If the gateway is online, this value will be null.
    - `macAddress` string, required: The gateway MAC address.
    - `model` string, required: The gateway model.
    - `deviceName` string, required: The gateway name.
    - `partNumber` string, required: The part number of the gateway.
    - `role` 'Isoleader' | 'Leader' | 'Member', required: Role of the gateway in the gateway cluster.
    - `serialNumber` string, required: The gateway serial number.
    - `siteId` string, required
    - `siteName` string, required: The site to which the gateway is assigned.
    - `softwareVersion` string, required: Firmware version currently running on the gateway.
    - `firmwareVersion` string, required: Firmware version currently running on the gateway.
    - `status` 'ONLINE' | 'OFFLINE', required: The status of the gateway, either Online or Offline.
    - `id` string, required: Primary identifier for the resource.
    - `type` string, required: The type of the resource.
  - `count` integer, required: The number of items in the response.
  - `total` integer: Specifies the total number of items available for a given filter query.
  - `next` string, int32, required: Indicates the next page number, or 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.
- `404`: 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)