---
title: "List Gateway tunnels"
method: GET
path: "/network-monitoring/v1/gateways/{serial-number}/tunnels"
tags: ["Gateways"]
---

# List Gateway tunnels

`GET /network-monitoring/v1/gateways/{serial-number}/tunnels`

## Request

- Base URL: `https://sso.common.cloud.hpe.com`
- URL: `https://sso.common.cloud.hpe.com/network-monitoring/v1/gateways/{serial-number}/tunnels`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://sso.common.cloud.hpe.com/as/token.oauth2`
- TypeScript: <https://skmtc.dev/arubanetworks/apis/authorization/docs/network-monitoring/v1/gateways/:serial-number/tunnels/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a list of tunnels present in a gateway with details like tunnelName, status, usage, encapsulation, etc.

## Path parameters

- `serial-number` string, required: The gateway serial number.

## Query parameters

- `filter` string
- `sort` string
- `limit` integer
- `next` string: Specifies the pagination cursor for the next page of resources.

## Response `200`

Object containing information about the tunnels present in the gateway.

- GatewayTunnelListResponse
  - `items` object[], required
    - `tunnelName` string, required: The name of the tunnel configured in the gateway.
    - `gateway` string, required: The name of the gateway to which the tunnel belongs.
    - `health` 'Good' | 'Fair' | 'Poor', required: The health status of the LAN tunnel.
    - `healthReasons` string[], 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.
    - `sourceIpAddress` string, ipv4, required: IP address from which the tunnel originates.
    - `destinationIpAddress` string, ipv4, required: IP address to which the tunnel terminates.
    - `mode` 'Orchestrated' | 'Orchestrated-IKE' | 'Orchestrated-Survivability' | 'IKE', required: The mode of the tunnel.
    - `vni` integer, required: Encoded value used to uniquely identify the Layer 2 segment in a VXLAN network. It is null for tunnels other than VXLAN.
    - `uptime` string, 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.
    - `mtu` integer, required: The MTU value of the port.
    - `lastConnected` number, float, required: The last time the tunnel was connected.
    - `greTunnelId` string, required: GRE tunnel identifier if applicable, null otherwise.
    - `greTunnelIpAddress` string, ipv4, required: IP address of the GRE tunnel if applicable, null otherwise.
    - `usage` object, required: Bandwidth usage statistics for the LAN tunnel.
      - `received` integer, required: Total bytes received through the tunnel.
      - `sent` integer, required: Total bytes sent through the tunnel.
      - `total` integer, required: Total bytes transmitted (sent + received) through the tunnel.
    - `throughput` object, required: Current throughput statistics for the LAN tunnel.
      - `received` integer, required: Current receive throughput in bytes per second.
      - `sent` integer, required: Current send throughput in bytes per second.
    - `droppedPackets` number, float, required: Number of packets dropped by the LAN tunnel.
    - `uplinkName` string, required: Name of the uplink interface associated with the tunnel.
    - `vlanId` integer, required: VLAN ID associated with the LAN tunnel.
    - `inSpi` integer, required: Inbound Security Parameter Index (SPI) for the tunnel.
    - `outSpi` integer, required: Outbound Security Parameter Index (SPI) for the tunnel.
    - `macAddress` string, required: The source gateway MAC address.
    - `peerType` string, required: Type of the tunnel peer.
    - `natEnabled` boolean, required: Indicates if NAT is enabled for the tunnel.
    - `nextReKey` integer, 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.
    - `id` string, required: Unique identifier for the LAN tunnel.
    - `type` string, required: Resource type identifier.
  - `count` integer, required: The number of items in the response.
  - `total` integer: Specifies the total number of items available for a given filter query.
  - `next` string, int32, required: Indicates the next page number, or null if there are no further pages.

## Other responses

- `400`: Invalid input received.
- `401`: Unauthorized. Authentication credentials are required or invalid.
- `403`: Forbidden: Access is denied.
- `404`: Not Found error.
- `429`: Too Many Requests. The user has sent too many requests in a given amount of time.
- `500`: Internal Server Error. An unexpected error occurred on the server.

---

[API](https://skmtc.dev/arubanetworks/apis/authorization.md) - [All operations](https://skmtc.dev/arubanetworks/apis/authorization/llms.txt) - [OpenAPI document](https://skmtc.dev/arubanetworks/apis/authorization/revisions/74c95058b11f?raw)