How do I add a VLAN?

Requires Basic

Quick answer

In the Network module, switch to the VLANs tab and click “Add VLAN”. Required are the VLAN ID (1–4094) and a name. Optionally, you can assign the VLAN to a VLAN group and add a description.

Prerequisites

Included in all plans from Basic onward.

Open the “VLANs” tab. Choose Network, then the VLANs tab. Click “Add VLAN”.

Screenshot pending netzwerk-vlan-01 The 'VLANs' tab in the Network module with the form for a new VLAN

The 'VLANs' tab with the form for a new VLAN.
Fill in the form.
- VLAN ID — a number between 1 and 4094 (e.g. 10)
- VLAN name — e.g. “Management”
- VLAN group (optional) — choose an existing group
- Description (optional)
If you want to bundle VLANs, first create a VLAN group via Add (only a name is required) and select it here.
Save. The VLAN appears in the list, sorted by VLAN ID in ascending order.

Via the REST API: a POST to /api/v1/network/vlans. Required are vlan_id and name.

curl -X POST https://demo.notory.io/api/v1/network/vlans \
  -H "Authorization: Bearer inv_dein_token" \
  -H "Content-Type: application/json" \
  -d '{
    "vlan_id": 10,
    "name": "Management",
    "description": "Out-of-Band Management"
  }'

{
  "id": "0190f3a2-8e33-7dab-b2c4-3e6f7a8b9c02",
  "tenant_id": "3d9b0c12-4e5a-4f88-b1c7-2a9e6d4f0011",
  "vlan_id": 10,
  "name": "Management",
  "description": "Out-of-Band Management",
  "group_id": null,
  "created_at": "2026-07-08T09:30:00Z",
  "updated_at": "2026-07-08T09:30:00Z"
}

You create a VLAN group separately (POST /api/v1/network/vlan-groups, name only) and reference its id on the VLAN via group_id.

Possible errors: 401, 403 (permissions/role), 422 (validation — e.g. vlan_id outside 1–4094 or empty name).

What happens behind the scenes?

Tenant assignment: The VLAN belongs to your current tenant.
ID validation: The VLAN ID must be in the range 1–4094; otherwise Notory rejects the creation with 422. The ID is indexed but not enforced as unique — the same number can occur more than once.
Group reference: If the linked VLAN group is deleted, Notory sets group_id to null (SET NULL); the VLAN remains.
Usage: VLANs are then available as a selection on IP addresses and IP ranges.