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

# List Gateway uplinks

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

## Request

- Base URL: `https://sso.common.cloud.hpe.com`
- URL: `https://sso.common.cloud.hpe.com/network-monitoring/v1/gateways/{serial-number}/uplinks`
- 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/uplinks/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a list of uplinks present in a gateway with details like link tag, status, public IP address etc.

## Path parameters

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

## Query parameters

- `sort` string

## Response `200`

Object containing information about the WAN interfaces present in the gateway.

- GatewayUplinkListResponse
  - `items` object[], required
    - `linkTag` string, required
    - `status` 'Up' | 'Down', required: The overall status of the uplink.
    - `wanStatus` 'Up' | 'Down', required: The WAN status of the uplink.
    - `linkStatus` 'Up' | 'Down', required: The link status of the uplink.
    - `publicIpAddress` string, ipv4, required: IP address logged when the uplink is connected to the gateway.
    - `privateIpAddress` string, ipv4, required: Private IP of the uplink connected to the gateway.
    - `vlanId` integer, required: The VLAN ID configured in the gateway.
    - `isBackupUplink` boolean, required: Indicates if this uplink is a backup uplink.
    - `usage` object, required: Bandwidth usage statistics of the uplink.
      - `received` integer, required: Total bytes received through the uplink.
      - `sent` integer, required: Total bytes sent through the uplink.
      - `total` integer, required: Total bytes transmitted (sent + received) through the uplink.
    - `throughput` object, required: Current throughput statistics for the WAN tunnel.
      - `received` integer, required: Current receive throughput in bytes per second.
      - `sent` integer, required: Current send throughput in bytes per second.
    - `id` string, required: Primary identifier for the resource.
    - `type` string, required: The type of the resource.
  - `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)