Sign in
Vlans

Update Vlan

put/api/v1/vlans/{id}

Path parameters

idstring uuid required

Vlan ID

Request body

descriptionstring nullable
namestring required
network_idstring uuid required
organization_idstring uuid required
subnet_idsstring[]

Subnets associated with this VLAN, derived from discovered interface native-VLAN data via the subnet_vlans junction. Hydrated by VlanService on read; it is not a column on vlans, so anything sent here on create/update is ignored by to_params.

vlan_numberinteger required

The 802.1Q VLAN number (1-4094)

created_atstring date-time required
first_discovery_idstring uuid nullable
idstring uuid required
last_discovery_idstring uuid nullable
last_seen_atstring date-time
lineage_idstring uuid nullable
updated_atstring date-time required
valid_fromstring date-time
valid_tostring date-time nullable

Response

Vlan updated

errorstring nullable
successboolean required

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.17.7"
  }
}

Changes