VLAN

Get all VLANs

get/vlan/

Request

  • Base URL
    https://core.hivelocity.net/api/v2
  • URL
    https://core.hivelocity.net/api/v2/vlan/
  • Auth
    API key in header X-API-KEY

Headers

X-Fieldsstring mask

An optional fields mask

Response

VLANs retrieved successfuly

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.

Changes

No recorded changes to this operation across all 1 revision of this API.