Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Gateways

Get summary of cluster tunnel health

Retrieves health summary of tunnels in a gateway-cluster.

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

Path parameters

cluster-namestring 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.

Example:cluster 1

The name of the cluster formed by the gateway.

Response

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

deviceNamestring

The gateway name.

serialNumberstring

The gateway serial number.

siteIdstring
idstring required

Primary identifier for the resource.

typestring required

The type of the resource.

Example response

{
  "deviceName": "gw_1",
  "serialNumber": "GW00000001",
  "siteId": "24833497",
  "id": "GW00000001",
  "type": "network-monitoring/gateway-monitoring"
}