Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Gateways

Get summary of gateway WAN tunnel health

Retrieves health summary of WAN tunnels present in the gateway.

get/network-monitoring/v1/gateways/{serial-number}/wan-tunnels-health-summary

Path parameters

serial-numberstring required

The gateway serial number.

Example:GW00000001

Serial number of the gateway device.

Response

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

health'Good' | 'Fair' | 'Poor' required

The cumulative health of the tunnel.

healthReasons'TUNNEL_STATUS' | 'TUNNEL_ENCAPSULATION' | 'TUNNEL_AUTHENTICATION' | 'TUNNEL_ENCRYPTION' required

The reason for the current health of the tunnel.

idstring required

Primary identifier for the resource.

typestring required

The type of the resource.

Example response

{
  "health": "Good",
  "healthReasons": "TUNNEL_STATUS",
  "id": "GW00000001",
  "type": "network-monitoring/gateway-monitoring"
}