Sign in
latestOpenAPI 3.1.0Dual (AGPL3.0, Commercial License Available)raw.githubusercontent.com2026-08-20211302936.6 KB

2df1fc47dfa7

Vlans

Create a new VLAN

Creates a VLAN scoped to a network. VLAN numbers must be unique within a network.

post/api/v1/vlans

Request body

descriptionstring nullable

Free-text notes about the VLAN.

namestring required

Human-facing name for this VLAN.

network_idstring uuid required

The network this entity belongs to.

organization_idstring uuid required

The organization that owns this record.

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

When this record was first created.

first_discovery_idstring uuid nullable

The discovery that first observed this entity.

idstring uuid required

Server-assigned unique identifier.

last_discovery_idstring uuid nullable

The most recent discovery that observed this entity.

last_seen_atstring date-time

When a discovery last observed this entity.

lineage_idstring uuid nullable

Stable identifier shared by every revision of the same entity across its history.

updated_atstring date-time required

When this record was last modified.

valid_fromstring date-time

Start of the interval this revision was current for (SCD2 history).

valid_tostring date-time nullable

End of the interval this revision was current for. null while it is the live revision.

Response

VLAN created successfully

errorstring nullable

Human-readable failure message. Omitted on success.

successboolean required

true when the request succeeded. false responses carry error instead of data.

Example response

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