action.skip
Megaport Documentation
API Deprecation FAQs
PDF

API Deprecation Notices and Frequently Asked Questions (FAQs)

This topic includes API deprecation notices and some common questions about the API version changes.

We recommend that you keep up to date with these changes and plan any API integration updates accordingly.

For more information on the APIs mentioned in this topic, see the API reference at https://dev.megaport.com.

May 2025 - API version changes

We’ve made some important updates to our API which might affect you. As a result of the updates, all users who currently integrate with these endpoints are required to migrate to the latest versions.

The key changes are listed in the table below. The deprecated APIs will be fully decommissioned on 31 July 2025.

Moving from v2 to v3:

  • v3 API is now available and required for:
    • GET location for all services
    • POST login with username and password
    • Notification settings APIs
    • GET activity logs
    • Invoice APIs (Note also that companyId has been updated to companyUid and supplierId has been added to the URL)

Moving from v3 to v4:

  • GET MVE Image Details


Function Old API New API
GET Locations
Returns a list of data centers where you can order a Port, MCR, or MVE.		 GET /v2/locations GET /v3/locations
POST Log in With Username and Password POST /v2/login POST /v3/login
GET List Notification Settings GET /v2/notificationPreferences GET /v3/notificationPreferences
PUT Change Notification Settings PUT /v2/notificationPreferences PUT /v3/notificationPreferences
GET User Activity GET /v2/activity GET /v3/activity
These endpoints are all now available:
  • /v3/activityNames
  • /v3/companyActivityNames
  • /v3/companyUserNames
GET Invoices
Returns a list of all the invoices for the company and billing market combination, for the specified date range.		 /v2/company/${companyid}/invoice/
supplierId/{supplierId}?fromDate=${fromDate}
&toDate=${toDate}		 /v3/company/${companyUid}/invoice/
supplierId/{supplierId}?fromDate=${fromDate}
&toDate=${toDate}
GET Single Invoice
Returns the specified invoice in JSON format.		 /v2/company/${companyid}/invoice/
${invoiceId}		 /v3/company/{companyUId}/supplier/
{supplierId}/invoice/{invoiceId}
GET Single Invoice PDF /v2/company/${companyid}/invoice/
${invoiceId}/pdf		 /v3/company/{companyUid}/supplier/
{supplierId}/invoice/{invoiceId}/pdf
GET Single Invoice CSV /v2/company/${companyId}/invoice/
${invoiceId}/csv		 /v3/company/{companyUid}/supplier/
{supplierId}/invoice/{invoiceId}/csv
GET MVE Image Details GET /v3/product/mve/images GET /v4/product/mve/images

February 2024 - New Invoice APIs

Our invoice APIs are changing.

To ensure you keep receiving the most accurate, up-to-date and complete invoice data, including credit notes and tax information, you are required to migrate to the new invoice API endpoints.

For more information about the invoice APIs, visit https://dev.megaport.com.

Which invoice APIs are impacted?

These API endpoints have been deprecated and replaced with new API endpoints.

Function Old API New API
GET Invoices GET /v2/invoice
Returns a list of invoices for the company associated with the user account.		 GET /v2/company/${companyUid}/invoice/supplierId/{supplierId}?fromDate=${fromDate}&toDate=${toDate}?
Returns a list of invoices for the company ID and billing market ID combination, for the specified date range.
GET Single Invoice GET v2/invoice/{invoiceId}
Returns the invoice for the specified invoiceId.		 GET /v2/company/${companyId}/invoice/${invoiceId}
Returns the invoice for the specified companyId and invoiceId in JSON format.
GET Single Invoice PDF GET /v2/invoice/{invoiceId}/pdf
Returns a PDF version of the invoice for the specified invoiceId.		 GET /v2/company/${companyId}/invoice/${invoiceId}/pdf
Returns a PDF version of the invoice for the specified companyId and invoiceId.
GET Single Invoice CSV GET /v2/invoice/{invoiceId}/csv
Returns a CSV version of the invoice for the specified invoiceId.		 GET /v2/company/${companyId}/invoice/${invoiceId}/csv
Returns a CSV version of the invoice for the specified companyId and invoiceId.

Where do I find the supplier and company information?

All of the new invoice APIs require you to send company and supplier information as part of the API call. You can find these values from the following Megaport APIs:

  • supplierId is the “firstPartyId” returned in the GET Billing Markets /v2/market API for the relevant supplier.
  • companyUid is returned in the GET Product List /v2/products API or the GET API Keys /v2/auth/apikeys API.
  • companyId is returned in the GET Company Details /v2/company/companyUid API.

When do I need to start using the new invoice APIs?

As soon as possible. The new invoice APIs are currently available in Production, any future enhancements related to invoices will be applied to the new APIs only.

When will the legacy invoice APIs be decommissioned?

The legacy invoice APIs have been deprecated and are no longer supported.

Who can I talk to for more information?

Please reach out to your Account Manager or Megaport Support. For more information, see Contacting Support.

April 2023 - v2 MVE APIs

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 Megaport Internet specifications. With this latest version, we’ve unbundled Megaport Internet to separate compute from Virtual Cross Connects (VXCs) and Megaport Internet connections. 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 multiple 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 higher-capacity options, 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 Megaport Internet connections as separate products. Existing API integrators who want to change the speed of their Megaport Internet connection will have to integrate with the new v3 API.

As a result, users who integrate with the Validate and Buy APIs for other service types, including Ports, MCRs, VXCs and IXs, in addition to MVEs and Megaport Internet connections, will also be required to migrate to the latest v3 version. No changes for these service types, other than the version, are applied to the url, request body or response body.

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 September 2024, at which time the legacy v2 API will be deprecated. When ordering an MVE with v2 APIs, a Megaport Internet connection 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 Megaport Internet connections to make the most out of the additional flexibility.

Our Customer Portal has already switched to v3 for:

Fetch prices of MVEs and VXCs:

  • GET /v3/pricebook/mve?locationId={locationId}&vendor={vendor}&size={size}
  • GET /v3/pricebook/vxc?bLocationId={bLocationId}&aLocationId={aLocationId}

Validate and Buy of all service types:

  • POST /v3/networkdesign/validate
  • POST /v3/networkdesign/buy

Update VXCs (only):

  • PUT /v3/product/vxc/{productUid}

Delete all service types:

  • POST /v3/product/{productUid}/action/{action}

When do I need to start using MVE API v3?

As soon as possible and no later than September 2024. The MVE v3 APIs are currently available in Production, any future enhancements related to MVE and Megaport Internet connections will be applied to the v3 APIs only.

When will the MVE v2 APIs be deprecated?

MVE v2 APIs will be deprecated on 30 September 2024.

Which v2 APIs are impacted?

This table lists the v2 APIs that are impacted by these changes:

Function Old API New API
Get MVE Price GET /v2/pricebook/mve
Returns price of MVE + Megaport Internet connection.		 GET /v3/pricebook/mve
Returns price of MVE compute only.
Get VXC Price GET /v2/pricebook/vxc
Does not return Megaport Internet price.		 GET /v3/pricebook/vxc
With connectType=transit, returns price of Megaport Internet connection.
Validate orders for all product types: Port, MCR, MVE, VXC, IX POST /v2/networkdesign/validate
For MVEs, validates order of MVE + Megaport Internet connection together.		 POST /v3/networkdesign/validate
For MVEs, validates order of MVE only.
Note: Available sizes are: "SMALL" "MEDIUM" "LARGE" "X_LARGE_12".
Buy services for all product types: Port, MCR, MVE, VXC, IX POST /v2/networkdesign/buy
For MVEs, buys MVE + Megaport Internet connection together.		 POST /v3/networkdesign/buy
For MVEs, buys the MVE only.
Can buy Megaport Internet connections alone.
Update VXC Details PUT /v2/product/vxc/{productUid}
Cannot update Megaport Internet connections.		 PUT /v3/product/vxc/{productUid}
Can update Megaport Internet connections.
Delete services for all product types: Port, MCR, MVE, VXC, IX POST /v2/product/{productUid}/
action/{action}		 POST /v3/product/{productUid}/
action/{action}

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.

Who can I talk to for more information?

Please reach out to your Account Manager or Megaport Support. For more information, see Contacting Support.