Sign in

v2

latestOpenAPI 3.0.02026-08-0688139156.5 KB
Devices

Update device VLAN

Update a virtual interface (VLAN) for a device.

patch/v1/device/{device_id}/vlan/{vlan_id}

Path parameters

device_idstring required

ID of a device

Example:d_0123456789ab
vlan_idstring required

The ID of the VLAN

Request body

gatewaystring ipv4

Gateway IP address. Required when network_mode is "static".

ip_addressstring

IP address and network mask in CIDR notation (e.g., "192.168.100.1/24"). Required when network_mode is "static".

namestring

Display name for the virtual interface

network_mode'dhcp' | 'static'

Network mode (DHCP or static IP)

network_update_pendingboolean

Returned in response only, to indicate that the network update is in progress.

vlan_taginteger

802.1Q VLAN tag (1-4094)

Example request

{
  "gateway": "192.168.100.1",
  "ip_address": "192.168.100.1/24",
  "name": "vlan100",
  "network_mode": "static",
  "vlan_tag": 100
}

Response

OK

gatewaystring ipv4

Gateway IP address. Required when network_mode is "static".

ip_addressstring

IP address and network mask in CIDR notation (e.g., "192.168.100.1/24"). Required when network_mode is "static".

namestring required

Display name for the virtual interface

network_mode'dhcp' | 'static' required

Network mode (DHCP or static IP)

network_update_pendingboolean

Returned in response only, to indicate that the network update is in progress.

vlan_idstring required

Unique identifier for the VLAN

vlan_taginteger required

802.1Q VLAN tag (1-4094)

Example response

{
  "gateway": "192.168.100.1",
  "ip_address": "192.168.100.1/24",
  "name": "vlan100",
  "network_mode": "static",
  "vlan_id": "vlan_012345",
  "vlan_tag": 100
}