API v2 Shutdown FAQs
In April 2023, we launched a new version of Megaport Virtual Edge (MVE). Previously, MVE had been offered as a bundle with preset compute, virtual circuits, and IP transit specifications. With this latest version, we’ve unbundled IP transit to separate compute from Virtual Cross Connects (VXCs) and transit VXCs. By unbundling compute and transit functions, you can now get a new level of configurability and flexibility by further customizing your network to suit your needs.
MVE is now also available in four sizes and has double the RAM of our previous version for better performance. The compute sizes are now 2/8, 4/16, 8/32, and 12/48, where the first number is the CPU and the second number is the GB of available RAM.
To enable this new feature, a v3 API has been created to get prices, validate, order, edit, and delete MVE and Transit VXCs as separate products. Existing API integrators who want to change the speed of their Transit VXC will have to integrate with the new v3 API.
To maintain backwards compatibility for our existing API integrators, API users will be able to keep using the current v2 Megaport API calls to order bundled MVEs until 30 April 2024, at which time the legacy v2 API will be deprecated. When ordering an MVE with v2 APIs, a transit VXC with the default speed associated to the selected MVE size will be created automatically.
All integrators are encouraged to migrate and start using the v3 APIs when ordering MVEs and Transit VXCs to make the most out of the additional flexibility.
When do I need to start using MVE API v3?
As soon as possible and no later than April 2024. The MVE v3 APIs are currently available in Production, any future enhancements related to MVE and Transit VXCs will be applied to the v3 APIs only.
When will the MVE v2 APIs be deprecated?
MVE v2 APIs will be deprecated on April 30, 2024 and no longer supported.
Which v2 APIs are impacted?
| Function | Old API | New API |
|---|---|---|
| Get MVE Price | GET /v2/pricebook/mve Returns price of MVE + Transit VXC |
GET /v3/pricebook/mve Returns price of MVE compute only |
| Get Transit VXC Price | GET /v3/pricebook/vxc With connectType=transit Returns price of Transit VXC |
|
| Validate MVE Order | POST /v2/networkdesign/validate Validates order of MVE + Transit VXC |
POST /v3/networkdesign/validate Validates order of MVE only Note: Available sizes are: "SMALL" "MEDIUM" "LARGE" "X_LARGE_12" |
| Validate Transit VXC Order | POST /v3/networkdesign/validate Validates order of Transit VXC |
|
| Buy MVE | POST /v2/networkdesign/buy Buys MVE + Transit VXC |
POST /v3/networkdesign/buy Buys MVE only |
| Buy Transit VXC | POST /v3/networkdesign/buy Buys Transit VXC |
|
| Update MVE Details | PUT /v2/product/mve/{productUid} | PUT /v2/product/mve/{productUid} No Change |
| Delete MVE | POST /v2/product/{productUid}/action/{action} | POST /v2/product/{productUid}/action/{action} No Change |
| Delete Transit VXC | POST /v3/product/{productUid}/action/{action} | |
| Get Partner Megaports | GET /v2/dropdowns/partner/megaports?connectType=transit Returns a list of destination ports for Transit VXCs |
What if I haven’t migrated in time?
Your MVE integration will stop working and you won’t be able to order new or update existing MVEs. For more information, please contact your account manager.
Are any other v2 APIs being deprecated?
No, all other existing v2 APIs will be maintained.
Who can I talk to for more information?
Please reach out to your account manager or Megaport Support. For details, see Contacting Support.