---
title: "Get Vlan by ID"
method: GET
path: "/api/v1/vlans/{id}"
tags: ["Vlans"]
---

# Get Vlan by ID

`GET /api/v1/vlans/{id}`

## Path parameters

- `id` string, uuid, required

## Response `200`

Vlan found

- 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

- `404` — Vlan not found

## Changes

- **2026-07-29** `51af15be596e` — 1 breaking, 1 info
  - added `subschema #1: Reason, subschema #2: Container` to the `data/allOf[#/components/schemas/VlanBase]/source/oneOf[subschema #4: DiscoveryWithMatch]/details/reason` response property `oneOf` list for the response status `200`
  - removed `subschema #1, subschema #2` from the `data/allOf[#/components/schemas/VlanBase]/source/oneOf[subschema #4: DiscoveryWithMatch]/details/reason` response property `oneOf` list for the response status `200`
- **2026-07-27** `bac7c2ccc950` — 1 info
  - added the optional property `data/allOf[#/components/schemas/VlanBase]/subnet_ids` to the response with the `200` status
- **2026-05-03** `d38c20597ec1` — 2 breaking, 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
  - added the optional property `data/allOf[subschema #2]/first_discovery_id` to the response with the `200` status
  - added the optional property `data/allOf[subschema #2]/last_discovery_id` to the response with the `200` status
  - …4 more
- …earlier changes not shown

[Full history](https://skmtc.dev/scanopy/apis/scanopy-api/changes/api/v1/vlans/:id/get.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/d061209476f3/schema)