---
updatedAt: 2026-05-27T19:42:41.000Z
agentTools:
  projectIndex: https://developers.hivelocity.net/llms.txt
---

# Get all VLANs

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/vlan/": {
      "get": {
        "operationId": "get_vlan_resource",
        "parameters": [
          {
            "description": "An optional fields mask",
            "in": "header",
            "name": "X-Fields",
            "schema": {
              "type": "string",
              "format": "mask"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "VLANs retrieved successfuly",
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/Vlan"
                  },
                  "type": "array"
                }
              }
            }
          },
          "403": {
            "description": "You have not been granted permission to complete this action. Please contact your account manager to grant the proper permission."
          }
        },
        "summary": "Get all VLANs",
        "tags": [
          "VLAN"
        ]
      }
    }
  },
  "info": {
    "description": "Interact with Hivelocity",
    "title": "Hivelocity API",
    "version": "2.0"
  },
  "security": [
    {
      "apiKey": []
    }
  ],
  "tags": [
    {
      "description": "Endpoints to manage VLANs",
      "name": "VLAN"
    }
  ],
  "servers": [
    {
      "url": "https://core.hivelocity.net/api/v2"
    }
  ],
  "components": {
    "securitySchemes": {
      "apiKey": {
        "in": "header",
        "name": "X-API-KEY",
        "type": "apiKey"
      }
    },
    "schemas": {
      "Vlan": {
        "properties": {
          "automated": {
            "description": "If true, VLAN can be automated via API. If false, contact support to enable automation.",
            "type": "boolean"
          },
          "facilityCode": {
            "description": "For example: `NYC1`.",
            "type": "string"
          },
          "ipIds": {
            "description": "Unique IDs of IP Assignments.",
            "items": {
              "type": "integer"
            },
            "type": "array"
          },
          "portIds": {
            "description": "Unique IDs of ports or bonds.",
            "items": {
              "type": "integer"
            },
            "type": "array"
          },
          "qInQ": {
            "description": "If true, VLAN is configured in Q-in-Q Mode. Automation is not currently supported on Q-in-Q VLANs.",
            "type": "boolean"
          },
          "type": {
            "description": "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.",
            "type": "string"
          },
          "vlanId": {
            "description": "Unique ID of the VLAN.",
            "type": "integer"
          },
          "vlanTag": {
            "description": "The VLAN Tag id from the switch. Use this value when configuring your OS interfaces to use the VLAN.",
            "type": "integer"
          }
        },
        "type": "object"
      }
    }
  }
}
```