Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Gateways

List Gateway uplinks

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

get/network-monitoring/v1/gateways/{serial-number}/uplinks

Path parameters

serial-numberstring required

The gateway serial number.

Example:GW00000001

Serial number of the gateway device.

Query parameters

sortstring

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 linkTag and status.

Response

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

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": [
    {
      "linkTag": "att",
      "status": "Up",
      "wanStatus": "Up",
      "linkStatus": "Up",
      "publicIpAddress": "220.227.124.242",
      "privateIpAddress": "10.27.103.66",
      "vlanId": 304,
      "isBackupUplink": false,
      "usage": {
        "received": 1000,
        "sent": 500,
        "total": 1500
      },
      "throughput": {
        "received": 1000,
        "sent": 500
      },
      "id": "GW00000001/uplinks/att",
      "type": "network-monitoring/gateway-monitoring"
    }
  ],
  "total": 1
}