---
title: "Get summary of cluster tunnel health"
method: GET
path: "/network-monitoring/v1/clusters/{cluster-name}/tunnels-health-summary"
tags: ["Gateways"]
---

# Get summary of cluster tunnel health

`GET /network-monitoring/v1/clusters/{cluster-name}/tunnels-health-summary`

## Request

- Base URL: `https://sso.common.cloud.hpe.com`
- URL: `https://sso.common.cloud.hpe.com/network-monitoring/v1/clusters/{cluster-name}/tunnels-health-summary`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://sso.common.cloud.hpe.com/as/token.oauth2`

Retrieves health summary of tunnels in a gateway-cluster.

## 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.

## Response `200`

Object containing information about the health summary of tunnels present in the gateway-cluster.

- ClusterTunnelHealthSummaryResponse
  - `deviceName` string: The gateway name.
  - `serialNumber` string: The gateway serial number.
  - `siteId` string
  - `tunnelHealth` object: Tunnel health summary for a cluster member.
    - `good` integer: The number of tunnels that are of good health.
    - `fair` integer: The number of tunnels that are of fair health.
    - `poor` integer: The number of tunnels that are of poor health.
  - `id` string, required: Primary identifier for the resource.
  - `type` string, 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`: 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)