show

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

Create an internet gateway

POST
/virtual-networks/{id}/internet-gateways

Creates an internet gateway.

  • Parameters
  • id
    string  (required) in path

    Virtual Network UUID

    length
    string  (required) in query

    IP Reservation length

Assign a native VLAN

POST
/ports/{id}/native-vlan

Assigns a virtual network to this port as a "native VLAN"

  • Parameters
  • id
    string  (required) in path

    Port UUID

    vnid
    string  (required) in query

    UUID or VNID of the virtual network to assign

Remove native VLAN

DELETE
/ports/{id}/native-vlan

Removes the native VLAN from this port

  • Parameters
  • id
    string  (required) in path

    Port UUID

Retrieve all virtual networks

GET
/projects/{id}/virtual-networks

Provides a list of virtual networks for a single project.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    string in query

    related attributes to include

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

Create an virtual network

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": "string",
        "description": "string",
        "facility": "string",
        "vxlan": "integer",
        "vlan": "integer"
    }

Get a virtual network

GET
/virtual-networks/{id}

Get a virtual network.

Delete a virtual network

DELETE
/virtual-networks/{id}

Deletes a virtual network.

  • Parameters
  • id
    string  (required) in path

    Virtual Network UUID