---
title: "Create a new VLAN"
method: POST
path: "/api/v1/vlans"
tags: ["Vlans"]
---

# Create a new VLAN

`POST /api/v1/vlans`

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

## Request body

- Vlan
  - `description` string, nullable — Free-text notes about the VLAN.
  - `name` string, required — Human-facing name for this VLAN.
  - `network_id` string, uuid, required — The network this entity belongs to.
  - `organization_id` string, uuid, required — The organization that owns this record.
  - `source` union
    - object
      - `type` 'Manual', required
    - object
      - `type` 'System', required
    - object
      - `type` 'Discovery', required
    - object
      - `details` MatchDetails, required
        - `confidence` 'NotApplicable' | 'Low' | 'Medium' | 'High' | 'Certain', required
        - `reason` union, required — Match reason - either a simple reason string or a container with nested reasons
          - object
            - `data` string, required — Why the service was matched.
            - `type` 'reason', required
          - object
            - `data` unknown[], required — Tuple of [name: string, children: MatchReason[]]
              - …
            - `type` 'container', required
      - `type` 'DiscoveryWithMatch', required
    - object
      - `type` 'Unknown', required
  - `subnet_ids` string[] — 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_number` integer, required — The 802.1Q VLAN number (1-4094)
  - `created_at` string, date-time, required — When this record was first created.
  - `first_discovery_id` string, uuid, nullable — The discovery that first observed this entity.
  - `id` string, uuid, required — Server-assigned unique identifier.
  - `last_discovery_id` string, uuid, nullable — The most recent discovery that observed this entity.
  - `last_seen_at` string, date-time — When a discovery last observed this entity.
  - `lineage_id` string, uuid, nullable — Stable identifier shared by every revision of the same entity across its history.
  - `updated_at` string, date-time, required — When this record was last modified.
  - `valid_from` string, date-time — Start of the interval this revision was current for (SCD2 history).
  - `valid_to` string, date-time, nullable — End of the interval this revision was current for. `null` while it is the live revision.

## Response `200`

VLAN created successfully

- ApiResponseVlan
  - `data` object — The result payload. Omitted on failure.
    - `description` string, nullable — Free-text notes about the VLAN.
    - `name` string, required — Human-facing name for this VLAN.
    - `network_id` string, uuid, required — The network this entity belongs to.
    - `organization_id` string, uuid, required — The organization that owns this record.
    - `source` union
      - object
        - `type` 'Manual', required
      - object
        - `type` 'System', required
      - object
        - `type` 'Discovery', required
      - object
        - `details` MatchDetails, required
          - `confidence` 'NotApplicable' | 'Low' | 'Medium' | 'High' | 'Certain', required
          - `reason` union, required — Match reason - either a simple reason string or a container with nested reasons
            - object
              - …
            - object
              - …
        - `type` 'DiscoveryWithMatch', required
      - object
        - `type` 'Unknown', required
    - `subnet_ids` string[] — 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_number` integer, required — The 802.1Q VLAN number (1-4094)
    - `created_at` string, date-time, required — When this record was first created.
    - `first_discovery_id` string, uuid, nullable — The discovery that first observed this entity.
    - `id` string, uuid, required — Server-assigned unique identifier.
    - `last_discovery_id` string, uuid, nullable — The most recent discovery that observed this entity.
    - `last_seen_at` string, date-time — When a discovery last observed this entity.
    - `lineage_id` string, uuid, nullable — Stable identifier shared by every revision of the same entity across its history.
    - `updated_at` string, date-time, required — When this record was last modified.
    - `valid_from` string, date-time — Start of the interval this revision was current for (SCD2 history).
    - `valid_to` string, date-time, nullable — End of the interval this revision was current for. `null` while it is the live revision.
  - `error` string, nullable — Human-readable failure message. Omitted on success.
  - `meta` ApiMeta, required — API metadata included in all responses
    - `api_version` integer, required — API version (integer, increments on breaking changes)
    - `server_version` string, required — Server version (semver)
  - `success` boolean, required — `true` when the request succeeded. `false` responses carry `error` instead of `data`.

## Other responses

- `400` — Validation error
- `409` — VLAN number already exists in this network

---

[API](https://skmtc.net/scanopy/apis/scanopy-api.md) · [All operations](https://skmtc.net/scanopy/apis/scanopy-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/scanopy/scanopy-api/revisions/2df1fc47dfa7/schema)