Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Gateways

Gateway tunnel detail

Retrieves information about a specific tunnel configured in the gateway.

get/network-monitoring/v1/gateways/{serial-number}/tunnels/{tunnel-name}

Path parameters

serial-numberstring required

The gateway serial number.

Example:GW00000001

Serial number of the gateway device.

tunnel-namestring required
Example:ap-ipsecmap-00:01:b2:22:02:25

Tunnel ID configured in the gateway.

Query parameters

start-atstring date-time

Date-time in RFC 3339 format (ISO 8601) in UTC timezone with milliseconds.

Example:2025-08-06T12:34:56.124Z

When not provided, the response returns the latest statistics. When provided, the response returns aggregated statistics over the specified time range. Aggregation starts from this timestamp, which must be in RFC 3339 (ISO 8601) format in UTC+0 timezone. The difference between end-at and start-at must be less than 30 days.

end-atstring date-time

Date-time in RFC 3339 format (ISO 8601) in UTC timezone with milliseconds.

Example:2025-08-06T12:34:56.124Z

Aggregation is computed up to this timestamp, which must be in RFC 3339 (ISO 8601) format in UTC+0 timezone. The timestamp must be earlier than the current time and later than start-at.

Response

Object containing details about a tunnel configured in the gateway.

tunnelNamestring required

The name of the tunnel configured in the gateway.

gatewaystring required

The name of the gateway to which the tunnel belongs.

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

The health status of the LAN tunnel.

healthReasonsstring[] required

Reasons contributing to the current health status of the tunnel.

status'Up' | 'Down' required

The operational status of the LAN tunnel.

encapsulation'IPSec' | 'GRE' | 'vxlan' required

Specifies the type of encapsulation used for the tunnel configured on the gateway.

sourceIpAddressstring ipv4 required

IP address from which the tunnel originates.

destinationIpAddressstring ipv4 required

IP address to which the tunnel terminates.

mode'Orchestrated' | 'Orchestrated-IKE' | 'Orchestrated-Survivability' | 'IKE' required

The mode of the tunnel.

vniinteger required

Encoded value used to uniquely identify the Layer 2 segment in a VXLAN network. It is null for tunnels other than VXLAN.

uptimestring required

The uptime duration of the LAN tunnel.

authentication'MD5' | 'SHA-1' | 'SHA-2 256' | 'SHA-2 384' | 'SHA-2 512' | 'AES' | '' required

The authentication method used in the tunnel.

encryption'3DES' | 'AES-128' | 'AES-192' | 'AES-256' | 'DES' | 'BLOWFISH' | 'AES-CTR' | 'AES-GCM-128' | 'AES-GCM-256' | 'AES-GMAC' | 'ESP-NULL' required

The encryption method used in the tunnel.

mtuinteger required

The MTU value of the port.

lastConnectednumber float required

The last time the tunnel was connected.

greTunnelIdstring required

GRE tunnel identifier if applicable, null otherwise.

greTunnelIpAddressstring ipv4 required

IP address of the GRE tunnel if applicable, null otherwise.

droppedPacketsnumber float required

Number of packets dropped by the LAN tunnel.

uplinkNamestring required

Name of the uplink interface associated with the tunnel.

vlanIdinteger required

VLAN ID associated with the LAN tunnel.

inSpiinteger required

Inbound Security Parameter Index (SPI) for the tunnel.

outSpiinteger required

Outbound Security Parameter Index (SPI) for the tunnel.

macAddressstring required

The source gateway MAC address.

peerTypestring required

Type of the tunnel peer.

natEnabledboolean required

Indicates if NAT is enabled for the tunnel.

nextReKeyinteger required

Timestamp for the next re-key event.

lastDownReason'SA expired' | 'Tunnel not established' | 'Uplink load balance configuration changed' | 'Tunnel configuration removed by Administrator' | 'DPD failure' | 'Delete initiated by peer' | 'Administrator cleared IPSEC SA' | 'New tunnel to the same peer has been created' | 'Unable to find IKE SA for IPSEC SA' required

The reason for the last time the tunnel was down.

tunnelType'LAN' | 'WAN' required

The type of the tunnel, either LAN or WAN.

idstring required

Unique identifier for the LAN tunnel.

typestring required

Resource type identifier.

Example response

{
  "tunnelName": "data-vpnc1-bocsim-uplink1_inet",
  "gateway": "GW00000001",
  "health": "Poor",
  "healthReasons": [
    "TUNNEL_STATUS"
  ],
  "status": "Down",
  "encapsulation": "VXLAN",
  "sourceIpAddress": "10.33.1.1",
  "destinationIpAddress": "200.1.1.1",
  "mode": "IKE",
  "vni": null,
  "uptime": "3d",
  "authentication": "SHA1",
  "encryption": "AES-256",
  "mtu": "1500",
  "lastConnected": "Mar 02, 2025 16:56",
  "greTunnelId": null,
  "greTunnelIpAddress": null,
  "usage": {
    "received": 1000,
    "sent": 500,
    "total": 1500
  },
  "throughput": {
    "received": 200,
    "sent": 100
  },
  "droppedPackets": 4,
  "uplinkName": "inet",
  "vlanId": 340,
  "inSpi": 123456789,
  "outSpi": 987654321,
  "macAddress": "00:44:55:66:78:4a",
  "peerType": "Cloud Gateway",
  "natEnabled": true,
  "nextReKey": 1741093011,
  "lastDownReason": null,
  "tunnelType": "LAN",
  "id": "GW00000001/tunnels/data-vpnc1-bocsim-uplink1_inet",
  "type": "network-monitoring/gateway-monitoring"
}