Sign in

v1

latestOpenAPI 3.0.02026-07-243339471.1 MB
Gateways

Gateway VLAN detail

Retrieves information about a specific VLAN that is configured in the gateway.

get/network-monitoring/v1/gateways/{serial-number}/vlans/{vlan-id}

Path parameters

serial-numberstring required

The gateway serial number.

Example:GW00000001

Serial number of the gateway device.

vlan-idstring required
Example:33

VLAN ID configured in the gateway.

Response

Object containing information about a VLAN configured in the gateway.

vlanIdinteger required

The VLAN ID configured in the gateway.

namestring

Name of the webhook. Must be unique per customer.

vlanType'Static' | 'Dynamic'

The type of VLAN configured in the gateway, either Static or Dynamic.

status'Up' | 'Down'

The status of the VLAN configured in the gateway.

adminStatus'Up' | 'Down'

The admin status of the VLAN.

ipv4string ipv4

IP address of the VLAN.

ipv4Subnetstring ipv4

IP address of the VLAN's subnet.

ipv4MaskAddrstring ipv4

The masked IP address of the VLAN.

interfacesstring

The interface to which the VLAN is assigned.

voicestring

The voice traffic of the VLAN.

ipv6Prefixstring

The prefix of the IPv6 address.

idstring required

Primary identifier for the resource.

typestring required

The type of the resource.

Example response

{
  "vlanId": 1,
  "name": "Default VLAN",
  "status": "Down",
  "vlanType": "Static",
  "adminStatus": "Down",
  "interfaces": "Unassigned",
  "ipv4": "0.0.0.0",
  "ipv4Subnet": null,
  "ipv4MaskAddr": "0.0.0.0",
  "ipv6Prefix": null,
  "voice": null,
  "id": "1",
  "type": "network-monitoring/gateway-monitoring"
}