Skip to content
Equnix Metal
show

VLANs copied!

Manage virtual networks (VLANs). See project endpoints to list and create virtual networks. Check out the product docs to learn more about VLANs.

Assign a port to virtual network copied!

POST
/ports/{id}/assign

Assign a port for a hardware to virtual network.

  • Parameters
  • id
    string  (required) in path

    Port UUID

    vnid
     (required) in body

    Virtual Network ID. May be the UUID of the Virtual Network record, or the VLAN value itself (ex: '1001').

    {
    "vnid": "string"
}

Unassign a port copied!

POST
/ports/{id}/unassign

Unassign a port for a hardware.

  • Parameters
  • id
    string  (required) in path

    Port UUID

    vnid
     (required) in body

    Virtual Network ID. May be the UUID of the Virtual Network record, or the VLAN value itself (ex: '1001').

    {
    "vnid": "string"
}

Assign a native VLAN copied!

POST
/ports/{id}/native-vlan

Sets a virtual network on this port as a "native VLAN". The VLAN must have already been assigned using the using the "Assign a port to a virtual network" operation.

  • Parameters
  • id
    string  (required) in path

    Port UUID

    vnid
    string  (required) in query

    Virtual Network ID. May be the UUID of the Virtual Network record, or the VLAN value itself (ex: '1001').

Remove native VLAN copied!

DELETE
/ports/{id}/native-vlan

Removes the native VLAN from this port

  • Parameters
  • id
    string  (required) in path

    Port UUID

Retrieve all virtual networks copied!

GET
/projects/{id}/virtual-networks

Provides a list of virtual networks for a single project.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

    facility
    string in query

    Filter by Facility ID (uuid) or Facility Code

    metro
    string in query

    Filter by Metro ID (uuid) or Metro Code

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Create a virtual network copied!

POST
/projects/{id}/virtual-networks

Creates an virtual network.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    virtual_network
     (required) in body

    Virtual Network to create

    project_id

    {
    "project_id": "string",
    "description": "string",
    "facility": "string",
    "metro": "string",
    "vxlan": "integer"
}

Get a virtual network copied!

GET
/virtual-networks/{id}

Get a virtual network.

Delete a virtual network copied!

DELETE
/virtual-networks/{id}

Deletes a virtual network.

  • Parameters
  • id
    string  (required) in path

    Virtual Network UUID