Skip to main content
This topic describes the API procedure to create a Megaport Virtual Edge (MVE), including how to look up a deployment location, check available vendor images, and validate and complete the order. Creating an MVE with the API involves these steps:
  1. Look up the MVE location — Identify a location where MVE is available and note its location ID.
  2. Check available MVE images — Retrieve the vendor images and software versions available for MVE.
  3. Validate the order — Test your configuration and review pricing before you order.
  4. Order the MVE — Submit the validated configuration to create the MVE.
You select the vendor appliance and software version through the required imageId field, taken from the images endpoint. There is no vendor field in the request. Each vendor also requires specific fields inside the vendorConfig object. For more information, see Vendor-specific configurations. Every request in this workflow requires the Authorization: Bearer <accessToken> header, including the two GET requests that look up locations and images. You reuse the same access token for every request. The requests use the {baseUrl} placeholder. Replace it with the production or staging API host. For more information, see Environments. Before you begin, obtain a valid access token. For more information, see Creating an API Key. For more information about the APIs and parameters mentioned in this topic, see the API reference at https://dev.megaport.com.

Look up MVE location details

To create an MVE, first identify a location where MVE is available. The location response includes mveAvailable in each diversity zone to indicate MVE support. To look up MVE location details
  1. Send a GET request to the locations endpoint. This request requires no parameters or request body.
    Confirm the request was successful by looking for Status: 200 OK. The request returns hundreds of Megaport locations.
  2. Search the response for a site where mveAvailable is true in the diversityZones object. To provision an MVE at a location, mveAvailable must be true in at least one diversity zone.
To create an MVE, you need the id value. In this example, the location ID is 60.

Check available MVE images

Before you create an MVE, retrieve the list of available vendor images. This endpoint returns the vendors and software versions available for MVE. Send a GET request to the images endpoint.
The response groups the available MVE images by vendor and product under mveImages. The following example is representative and is trimmed to a few vendor groups.
Each group carries the vendor code and product name, and lists the software versions under images. Note the id value for the image you want to deploy. The image id selects both the vendor appliance and the software version, and it is passed as imageId when you create the MVE. The vendorProductId in the response is informational only; you do not include it in the order body.

Validate the MVE order

Before you order, validate the configuration to confirm that it passes validation and to review pricing. To test and validate the MVE order
  1. Send a POST request to the validate endpoint with the request body.
  2. Confirm the response returns “Validation passed” and review the pricing details.
The request body is a JSON array that contains one order object. This example validates a 6WIND MVE.
The following table describes the request parameters. A successful response passes validation and includes pricing details.

Order the MVE

After validating the request and reviewing the pricing, place the same order object in the networkDesign array of the v4 request body, then POST the request to the buy endpoint to create the MVE. To order the validated MVE
  1. Send a POST request to the order endpoint with the v4 request body shown below.
    If you make this call on api.megaport.com, your account will be charged for the service. Alternatively, you can use the API in the staging (test) environment without charges, as in these examples.
  2. Review the response to confirm the MVE was created.
The v4 request body is an envelope object that wraps the order object in a networkDesign array. This example orders a standalone 6WIND MVE.
The following table describes the envelope parameters. A successful response confirms the MVE was created.
The new MVE appears in your working environment, either portal.megaport.com or portal-staging.megaport.com.
For the authoritative list of endpoints and parameters, and to confirm the current endpoint version, see https://dev.megaport.com.

Vendor-specific configurations

Each MVE vendor requires specific fields inside the vendorConfig object. The vendorConfig object contains no vendor key, the vendor appliance is chosen by the imageId value. Find your vendor below for its configuration requirements. The per-vendor examples below show only the vendor-specific fields. In a real order, the vendorConfig object also includes imageId and the size field (mveLabel) alongside these fields. A complete order can also include the top-level vnics array, a sibling of vendorConfig, to control the number and naming of vNICs. If you omit vnics, the vendor’s minimum number of vNICs is allocated automatically. For more information, see Validate the MVE order.
Obtain vendor licenses and credentials from the vendor. Consult the vendor’s documentation for vNIC requirements. Available sizes and vendors vary by location. For more information, see https://dev.megaport.com.

6WIND VSR

6WIND Virtual Service Router (VSR) requires an SSH public key for administrative access. Prerequisites:
  • Valid 6WIND license, obtained from 6WIND.
  • SSH public key (RSA 2048-bit, in OpenSSH or RFC4716 format).

Anapaya Alliance

Anapaya Alliance requires an SSH public key for administrative access. Prerequisites:
  • Valid Anapaya license.
  • SSH public key (RSA 2048-bit).

Arista VeloCloud

Arista VeloCloud requires SSH access and activation against your VeloCloud Orchestrator. Prerequisites:
  • Valid Arista VeloCloud license.
  • Access to your VeloCloud Orchestrator.
  • SSH public key (RSA 2048-bit).

Aruba EC-V

Aruba EdgeConnect Virtual (EC-V) requires your Orchestrator account credentials. Prerequisites:
  • Valid Aruba EdgeConnect license.
  • Aruba Orchestrator account name and account key.

Aviatrix

Aviatrix requires a cloud-init configuration file from your Aviatrix Controller. Prerequisites:
  • Aviatrix Controller with the appropriate edge license.
  • Cloud-init configuration file from the controller.

Check Point CloudGuard

Check Point CloudGuard requires an administrator password and an SSH public key. Prerequisites:
  • Valid Check Point CloudGuard license.
  • SSH public key (RSA 2048-bit).

Cisco

Cisco offers multiple MVE appliances. Select the configuration for your deployment model.

Cisco C8000 SD-WAN mode

Cisco C8000 in SD-WAN mode joins a Cisco Catalyst SD-WAN overlay and requires a cloud-init configuration. Prerequisites:
  • Cisco SD-WAN subscription and vManage access.
  • Cloud-init configuration file.
Cisco SD-WAN MVEs are typically created through vManage rather than through the Megaport API directly. For more information, see Creating an MVE Integrated with Cisco SD-WAN.

Cisco C8000 autonomous mode

Cisco C8000 in autonomous mode operates as a standalone router and requires an SSH public key. Prerequisites:
  • Valid Cisco C8000V license.
  • SSH public key (RSA 2048-bit).

Cisco Secure Firewall Threat Defense Virtual (FTDV)

Cisco Secure Firewall Threat Defense Virtual (FTDV) requires an administrator password and a management mode. When you manage the firewall through a Firewall Management Center (FMC), set manageLocally to false and provide the FMC details. Prerequisites:
  • Valid Cisco Secure Firewall license.
  • For remote management, a reachable Firewall Management Center (FMC).
Cisco Secure Firewall does not support the MVE 2/8 size.

Cisco Meraki vMX

Cisco Meraki vMX requires an authentication token from the Meraki dashboard. Prerequisites:
  • Valid Meraki SD-WAN license.
  • Authentication token from the Meraki dashboard.

F5 BIG-IP

F5 BIG-IP requires an administrator password hash and an SSH public key. Prerequisites:
  • Valid F5 BIG-IP license.
  • SSH public key (RSA 2048-bit or ED25519).

Fortinet FortiGate-VM

Fortinet FortiGate-VM requires an SSH public key and optionally a license file. Prerequisites:
  • SSH public key (RSA 2048-bit).
  • Optionally, a FortiGate-VM license file. If you do not provide one, apply a license after deployment, for example through FortiFlex.

Juniper

Juniper offers two MVE appliances. Select the configuration for your product.

Juniper SSR

Juniper Session Smart Router (SSR) requires a registration code from Juniper. Prerequisites:
  • Juniper Mist subscription.
  • Registration code from Juniper.

Juniper vSRX

Juniper vSRX requires an administrator password hash and an SSH public key, with optional Mist onboarding. Prerequisites:
  • Valid Juniper vSRX license.
  • SSH public key (RSA 2048-bit).
  • Optionally, Juniper Mist onboarding details.

Netskope One Edge

Netskope One Edge requires an SSH public key and an administrator password hash, with optional activation details. Prerequisites:
  • Valid Netskope One license.
  • SSH public key (RSA 2048-bit).

OPNsense

OPNsense from Deciso requires an SSH public key and a bcrypt administrator password hash. Prerequisites:
  • Valid OPNsense license from Deciso.
  • SSH public key (RSA 2048-bit, RSA 4096-bit, or ED25519).
Peplink Fusion Hub requires an administrator password hash and a valid Peplink Fusion Hub license. Prerequisites:
  • Valid Peplink Fusion Hub license.

Palo Alto

Palo Alto Networks offers two MVE appliances. Select the configuration for your product.

Palo Alto Prisma SD-WAN

Palo Alto Networks Prisma SD-WAN requires an ION key and a secret key from your Prisma SD-WAN controller. Prerequisites:
  • Valid Prisma SD-WAN license.
  • ION key and secret key from the Prisma SD-WAN controller.
Prisma SD-WAN is available as two models. The 3108v model supports the MVE 2/8, MVE 4/16, and MVE 8/32 sizes. The 7108v model supports the MVE 8/32 size only.

Palo Alto VM-Series

Palo Alto Networks VM-Series requires an SSH public key and an administrator password hash, with an optional authorization code. Prerequisites:
  • Valid VM-Series license (authorization code).
  • SSH public key (RSA 2048-bit).

Versa FlexVNF

Versa FlexVNF requires Director and Controller addresses and authentication identifiers. Prerequisites:
  • Valid Versa license.
  • Access to your Versa Director and Controller.

Instance sizes

MVE instances are available in different sizes. Specify the size using the mveLabel field. The productSize field is a deprecated, legacy alternative that is retained for backward compatibility. Available sizes depend on the vendor and location. Confirm the sizes available for your deployment with the MVE images endpoint or the product variants endpoint ({baseUrl}/v3/product/mve/variants). The following per-vendor size restrictions apply:
  • Cisco Secure Firewall does not support the MVE 2/8 size.
  • Palo Alto Prisma SD-WAN 3108v supports the MVE 2/8, MVE 4/16, and MVE 8/32 sizes.
  • Palo Alto Prisma SD-WAN 7108v supports the MVE 8/32 size only.

vNIC configuration

Each MVE has 1 to 5 virtual network interfaces (vNICs). The maximum is 5 for all vendors, except Arista VeloCloud and Check Point, which support only 1, and Cisco Meraki vMX, which supports only 2. The number of vNICs cannot be changed after the MVE is created. Provide the vNICs in the vnics array, as a sibling of vendorConfig on the order object. This example is trimmed to show the placement.
The following table describes the vNIC parameters.
Consult your vendor’s documentation for vNIC requirements. The confirmed per-vendor minimums are:
  • 6WIND VSR — minimum 1
  • Anapaya Alliance — minimum 1
  • Arista VeloCloud — exactly 1
  • Aruba EC-V — minimum 2
  • Aviatrix — minimum 1
  • Check Point CloudGuard — exactly 1
  • Cisco C8000 (autonomous and SD-WAN) — minimum 1
  • Cisco Secure Firewall (FTDV) — minimum 4
  • Cisco Meraki vMX — exactly 2
  • F5 BIG-IP — minimum 1
  • Fortinet FortiGate-VM — minimum 1
  • Juniper SSR — minimum 3
  • Juniper vSRX — minimum 2
  • Netskope One Edge — minimum 1
  • OPNsense — minimum 2
  • Palo Alto Prisma SD-WAN — minimum 4 (3108v) or 3 (7108v)
  • Palo Alto VM-Series — minimum 2
  • Versa FlexVNF — minimum 1

Next steps

After you create an MVE, the next steps include:

Helpful references

Last modified on September 3, 2026