v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Gateways

List Gateway Cluster tunnels

Retrieves a list of tunnels present in a gateway-cluster with details like tunnel name, gateway, encapsulation, health and more.

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

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.

Query parameters

filterstring

OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.

Field	Operators
tunnelName	eq and in
health	eq and in
status	eq and in
gateway	eq and in
encapsulation	eq and in
mode	eq and in

The operators are implemented as follows:

eq: Only values exactly matching the given value are returned.
in: Only values present in the given list are returned.

sortstring

Example:encapsulation desc

A comma-separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).

The first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.

Supported fields are tunnelName, gateway, encapsulation, destinationIpAddress, sourceIpAddress, mode, uptime and vni.

limitinteger

Example:20

Denotes the maximum number of tunnels returned in the response.

nextstring

Specifies the pagination cursor for the next page of resources.

Example:1

Specifies the pagination cursor for the next page of resources.

Minimum value: 1

Response

Object containing information about the tunnels present in a gateway cluster.

countinteger required

The number of items in the response.

totalinteger

Specifies the total number of items available for a given filter query.

nextstring int32 required

Indicates the next page number, or null if there are no further pages.

Example response

{
  "items": [
    {
      "tunnelName": "ap-ipsecmap-00:01:b2:22:02:1f",
      "gateway": "7010_1",
      "gatewayRole": "Isoleader",
      "health": "Good",
      "healthReasons": [],
      "status": "Up",
      "encapsulation": "IPSec",
      "destinationName": "CMZR001874",
      "destinationSerial": "CMZR001874",
      "destinationSite": "12345",
      "sourceIpAddress": "0.0.0.0",
      "destinationIpAddress": "198.167.10.1",
      "mode": "ORCH",
      "ssid": "Chennai-Employee, Chennai-Public",
      "vni": null,
      "uptime": 123456789,
      "id": "ap-ipsecmap-00:01:b2:22:02:1f",
      "type": "network-monitoring/gateway-monitoring"
    }
  ],
  "count": 1,
  "total": 1,
  "next": null
}