---
title: "Create VLAN"
method: POST
path: "/vlan/"
tags: ["VLAN"]
---

# Create VLAN

`POST /vlan/`

## Headers

- `X-Fields` string, mask

## Request body

- VlanCreate
  - `facilityCode` string, required — The Facility where the VLAN will be created, for example: `NYC1`. Only Devices from the same Facility are allowed in the VLANs.
  - `type` 'public' | 'private', required — Choose `public` if you want to be able to assign IPs to the VLAN, making it reachable from the internet. Choose `private` if the VLAN should never be reachable from the internet. All VLANs are subject to traffic billing and overages, with the exception of private VLAN traffic on unbonded Devices.

## Response `200`

Success

- Vlan
  - `automated` boolean — If true, VLAN can be automated via API. If false, contact support to enable automation.
  - `facilityCode` string — For example: `NYC1`.
  - `ipIds` integer[] — Unique IDs of IP Assignments.
  - `portIds` integer[] — Unique IDs of ports or bonds.
  - `qInQ` boolean — If true, VLAN is configured in Q-in-Q Mode. Automation is not currently supported on Q-in-Q VLANs.
  - `type` string — If `public`, this VLAN can have IPs assigned to become reachable from the internet. If `private`, this VLAN can not have IPs assigned and will never be reachabled from the internet. All VLANs are subject to traffic billing and overages, with the exception of private VLAN traffic on unbonded Devices.
  - `vlanId` integer — Unique ID of the VLAN.
  - `vlanTag` integer — The VLAN Tag id from the switch. Use this value when configuring your OS interfaces to use the VLAN.

## Other responses

- `201` — VLAN created successfully.
- `400` — Invalid VLAN creation parameter.
- `403` — You have not been granted permission to complete this action. Please contact your account manager to grant the proper permission.

---

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