---
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
  - `name` string, required
  - `network_id` string, uuid, required
  - `organization_id` string, uuid, required
  - `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
            - `type` 'reason', required
          - object
            - `data` unknown[], required — Tuple of [name: string, children: MatchReason[]]
              - …
            - `type` 'container', required
      - `type` 'DiscoveryWithMatch', required
    - object
      - `type` 'Unknown', required
  - `vlan_number` integer, required — The 802.1Q VLAN number (1-4094)
  - `created_at` string, date-time, required
  - `first_discovery_id` string, uuid, nullable
  - `id` string, uuid, required
  - `last_discovery_id` string, uuid, nullable
  - `last_seen_at` string, date-time
  - `lineage_id` string, uuid, nullable
  - `updated_at` string, date-time, required
  - `valid_from` string, date-time
  - `valid_to` string, date-time, nullable

## Response `200`

VLAN created successfully

- ApiResponseVlan
  - `data` object
    - `description` string, nullable
    - `name` string, required
    - `network_id` string, uuid, required
    - `organization_id` string, uuid, required
    - `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
    - `vlan_number` integer, required — The 802.1Q VLAN number (1-4094)
    - `created_at` string, date-time, required
    - `first_discovery_id` string, uuid, nullable
    - `id` string, uuid, required
    - `last_discovery_id` string, uuid, nullable
    - `last_seen_at` string, date-time
    - `lineage_id` string, uuid, nullable
    - `updated_at` string, date-time, required
    - `valid_from` string, date-time
    - `valid_to` string, date-time, nullable
  - `error` string, nullable
  - `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

## Other responses

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

## Changes

- **2026-05-03** `d38c20597ec1` — 2 breaking, 2 warning, 6 info
  - removed the required property `data/allOf[#/components/schemas/VlanBase]/source/oneOf[subschema #3: Discovery]/metadata` from the response with the `200` status
  - removed the required property `data/allOf[#/components/schemas/VlanBase]/source/oneOf[subschema #4: DiscoveryWithMatch]/metadata` from the response with the `200` status
  - removed the request property `allOf[#/components/schemas/VlanBase]/source/oneOf[subschema #3: Discovery]/metadata`
  - removed the request property `allOf[#/components/schemas/VlanBase]/source/oneOf[subschema #4: DiscoveryWithMatch]/metadata`
  - …6 more
- **2026-04-20** `f04499e2280f` — 2 breaking, 6 warning, 2 info
  - added the new required request property `allOf[#/components/schemas/VlanBase]/source/oneOf[subschema #3: Discovery]/metadata`
  - added the new required request property `allOf[#/components/schemas/VlanBase]/source/oneOf[subschema #4: DiscoveryWithMatch]/metadata`
  - removed the optional property `data/allOf[subschema #2]/first_discovery_id` from the response with the `200` status
  - removed the optional property `data/allOf[subschema #2]/last_discovery_id` from the response with the `200` status
  - …6 more

[Change history](https://skmtc.dev/scanopy/apis/scanopy-api/changes/api/v1/vlans/post.md)

---

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