Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Gateways

Get summary of cluster tunnel status

Retrieves the count of inter-gateway tunnels (tunnels in-between gateways in a cluster) that are Up and Down in a gateway-cluster.

get/network-monitoring/v1/clusters/{cluster-name}/tunnels-status-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 the count of inter-gateway tunnels that are Up and Down in a gateway-cluster.

upinteger

The number of tunnels that are Up.

downinteger

The number of tunnels that are Down.

idstring required

Primary identifier for the resource.

typestring required

The type of the resource.

Example response

{
  "up": 3,
  "down": 0,
  "id": "cluster1/tunnels",
  "type": "network-monitoring/gateway-monitoring"
}