v1

latestOpenAPI 3.0.02026-07-26258182277.4 KB

VLAN

Create VLAN

post/vlan/

Headers

X-Fieldsstring mask

An optional fields mask

Request body

facilityCodestring 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.

Example request

{
  "type": "private"
}

Response

Success

automatedboolean

If true, VLAN can be automated via API. If false, contact support to enable automation.

facilityCodestring

For example: NYC1.

ipIdsinteger[]

Unique IDs of IP Assignments.

portIdsinteger[]

Unique IDs of ports or bonds.

qInQboolean

If true, VLAN is configured in Q-in-Q Mode. Automation is not currently supported on Q-in-Q VLANs.

typestring

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.

vlanIdinteger

Unique ID of the VLAN.

vlanTaginteger

The VLAN Tag id from the switch. Use this value when configuring your OS interfaces to use the VLAN.