Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Gateways

Get details of gateway uplink

Retrieves details of the uplink connected to the gateway.

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

Path parameters

serial-numberstring required

The gateway serial number.

Example:GW00000001

Serial number of the gateway device.

link-tagstring required
Example:Airtel

Name of the uplink interface.

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 information about the uplink connected to the gateway.

linkTagstring 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.

publicIpAddressstring ipv4 required

IP address logged when the uplink is connected to the gateway.

privateIpAddressstring ipv4 required

Private IP of the uplink connected to the gateway.

vlanIdinteger required

The VLAN ID configured in the gateway.

isBackupUplinkboolean required

Indicates if this uplink is a backup uplink.

idstring required

Primary identifier for the resource.

typestring required

The type of the resource.

Example response

{
  "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"
}