View All Products
Compute
Storage
Databases
Networking
Developer Tools
Delivery
Security
Services
Industries
Pricing
Community
Engage With Us
Linode API 4.163.0

Endpoints

Networking

VLANs List

get
https://api.linode.com/v4beta/networking/vlans
BETA

Returns a list of all Virtual Local Area Networks (VLANs) on your Account. VLANs provide a mechanism for secure communication between two or more Linodes that are assigned to the same VLAN and are both within the same Layer 2 broadcast domain.

VLANs are created and attached to Linodes by using the interfaces property for the following endpoints:

There are several ways to detach a VLAN from a Linode:

  • Update the active Configuration Profile to remove the VLAN interface, then reboot the Linode.
  • Create a new Configuration Profile without the VLAN interface, then reboot the Linode into the new Configuration Profile.
  • Delete the Linode.

Note: Only Next Generation Network (NGN) data centers support VLANs. Use the Regions (/regions) endpoint to view the capabilities of data center regions. If a VLAN is attached to your Linode and you attempt to migrate or clone it to a non-NGN data center, the migration or cloning will not initiate. If a Linode cannot be migrated because of an incompatibility, you will be prompted to select a different data center or contact support.

Note: See the VLANs Overview to view additional specifications and limitations.

Query Parameters

page
integer > = 1
Default: 1

The page of a collection to return.

page_size
integer [25 .. 500]
Default: 100

The number of items to return per page.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    https://api.linode.com/v4beta/networking/vlans/

Response Samples

{
  "data": [
    {
      "created": "2020-01-01T00:01:01",
      "label": "vlan-example",
      "region": "ap-west",
      "linodes": [
        "111",
        "222"
      ]
    }
  ],
  "page": 1,
  "pages": 1,
  "results": 1
}

Responses

200: The VLANs available on this Account.

data
array of objects
created
string

The date this VLAN was created.

label
Filterable
string

The name of this VLAN.

region
Filterable
string

This VLAN's data center region.

Note: Currently, a VLAN can only be assigned to a Linode within the same data center region.

linodes
array

An array of Linode IDs attached to this VLAN.

page
integer

The current page.

pages
integer

The total number of pages.

results
integer

The total number of results.

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.