Release Notes

New Endpoint for IPsec Data – A new endpoint GET /v3/products/mcrs/{productUid}/ipsec has been created to retrieve IPsec-related data. The endpoint response Body includes the following:

• Max IPsec tunnel count limit for the MCR.
• Total tunnel count - total number of configured tunnels for an MCR.
• The list of IPsec configured tunnels with details, including:
  • VXC name
  • VXC product Uid
  • VLAN
  • IPsec tunnels (sourceIpAddress, destinationIpAddress, description)

invitationPending field added to /v2/employee – Added the invitationPending field to the GET /v2/employee endpoint response to improve employee invitation status visibility.

Cross Connect Ordering – In the networkdesign/validate and networkdesign/buy endpoints, the Cross Connect implementation has been updated to use the addOn config instead of the crossConnectRequested flag.

Partner Resource Limits – Megaport partners can now configure resource limits for their managed companies via the API. The POST and PUT /v2/managedCompanies endpoints now accept a new optional field in the request Body called resourceLimits.

Changes for GET /v4/product/mve/images – These changes have been made to the response Body of this endpoint:

• A new field vendorProductId has been added. This is a unique identifier generated by concatenating the product and vendor values.
• MVE images are now returned with the most recent (highest id) being returned first, per product and vendor.

GET /v3/locations – The Megaport Portal has been updated to use the new /v3/locations API endpoint instead of /v2/locations. The /v2/locations public API is now deprecated and will be fully decommissioned on 31 July 2025. For more information, see API Deprecation Notices and Frequently Asked Questions (FAQs).

Invoice APIs Updated to V3 – The Megaport Portal has been updated to use the new v3 invoice API endpoints instead of v2. Note also that companyId has been updated to companyUid, and supplierId has been added to the URL in the v3 version. The v2 public APIs are now deprecated and will be fully decommissioned on 31 July 2025. For more information, see API Deprecation Notices and Frequently Asked Questions (FAQs).

Jumbo Frame Support on MCR – A new field ipMtu has been added to the following endpoints which allows you to set the largest size (in bytes) of an IP packet that can be sent over the connected VXC.

• POST /v3/networkdesign/validate
• POST /v3/networkdesign/buy
• PUT /v3/product/vxc/{uid}

Invoice Endpoint Improvements – The invoicing endpoints have been updated to change the Invoice Charge From/To date fields to reflect the time period to which the ETF applies - the ETF duration.

Updated GET /v3/locations – These improvements have been made to the /v3/locations endpoint:

• Added the optional parameter mveImageId. When including the mveImageId, the endpoint will return only the locations that have capacity for the mveImageId. If the mveImageId is not passed in, the mveMaxCpuCoreCount value will always be null.
• Added the MCR speed field (mcrSpeedMbps).

New /v3/notificationPreferences Endpoint – The /v3/notificationPreferences endpoint has been added to allow users to subscribe to individual notifications or notification groups in the Megaport Portal. This endpoint replaces the previous /v2/notificationPreferences endpoint. For more information, see Email Notifications.

Removed the PUT /v2/product/cxc/{productUid} Endpoint – The PUT /v2/product/cxc endpoint has been deprecated as all active CXC services have been migrated to VXCs. Users should access the PUT /v2/product/vxc/{productUid} endpoint instead.

Oracle Virtual Circuit ID Now Returned – Improvements have been made to the public APIs relating to Oracle VXCs. The virtualCircuitId field (the VLAN ID on the Oracle side of the VXC) is now returned in the response for these APIs:

• GET /v2/product/{uid}
• GET /v2/products
• POST /v3/networkdesign/validate
• POST /v3/networkdesign/buy

Activity Logging – Improvements have been made to the account activity information that is logged and displayed in the Megaport Portal. A new API v3/activity has also been created that can be used to retrieve activity logs for the logged-in user.

Deprecate v2 APIs Replaced by v3 APIs – As previously communicated, some of our v2 APIs have been superseded by v3 versions and were scheduled for deprecation. These v2 APIs have now been officially deprecated and no longer supported by Megaport:

• Get MVE Price: GET /v2/pricebook/mve
• Get VXC Price: GET /v2/pricebook/vxc
• Validate Orders: POST /v2/networkdesign/validate
• Buy Services: POST /v2/networkdesign/buy
• Update VXC Details: PUT /v2/product/vxc/{productUid}
• Delete Services: POST /v2/product/{productUid}/action/{action}

Removed MCR BFD Timer Settings – Support for maintaining MCR BFD timer settings has been removed from the API. The BFD settings are not editable, the default values configured when BFD is enabled are Transmit Interval: 300 milliseconds, Receive Interval: 300 milliseconds, Multiplier: 3.

Resource Tagging – Customers now have the ability to create, modify, and delete resource tags to manage their active services via the Megaport API. Resource tags are key and value pairs that act as metadata for organizing Megaport resources. These tags will appear in the Service Inventory report by default for the company who has implemented the tags providing they own the service the tag is put against.

Telemetry CSV Download – The service telemetry APIs can now download utilization data in CSV format as well as text format. For more information, see Metric Types.

GET /v2/product/{productUid} Speed Improvements – The performance of this API has been optimised. In some cases, the load time for this API for larger companies has halved.

Support for Monitoring Maintenance and Outage Events – The /ens/v1/status/outage and /ens/v1/status/maintenance public APIs have been created which allow you to monitor maintenance activities and service outages. For more information, see Maintenance and Outage Events.

Fixed – NPE errors were occurring in the /v2/employment endpoint because the user did not have an email address defined.

Megaport Internet Available in More Countries – Megaport Internet connections can now also be ordered from Ports and MCRs in New Zealand, Canada, and Singapore, in addition to Australia, UK and the US where it was already available.

New /v3/login API – A new /v3/login API has been created to replace the soon to be deprecated /v2/login API. The v2 API will no longer be supported; please migrate any API integrations you have from the v2 version to the new v3 API version.

GSA/GRA Updated – Megaport has updated the standard Global Services Agreement (GSA) and Global Reseller Agreement (GRA) terms (in accordance with Clauses 15(a) and 20(a) respectively). As part of this update, the early termination fee (ETF) applied to a service on a contract that is canceled before the term is complete has changed from 50% to 100%. This change took effect in the Megaport Portal on April 15, 2024.

New Service Inventory API – A new public API /v2/secure/inventory/companies/{companyUid}/services/csv has been created which allows you to download your service inventory, including historical services, in comma-separated values (CSV) file format. You can also return the service inventory in JSON format using the /v2/secure/inventory/companies/{companyUid}/services API. For more information, see Service Inventory Report.

New Invoice APIs – 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, see New Invoice APIs FAQs and Invoices.

MCR and MVE Diversity – You can now choose a diversity zone when creating MCRs and MVEs. You can pass the diversityZone parameter when validating and ordering an MCR and MVE via API. For more information, see Buy MCR (v3) and the Buy MVE (v3) endpoint for the relevant vendor.

Terms on VXC – VXCs can now be put on a 12, 24, or 36 month term. The following APIs have been updated to accept the new optional field term to put a VXC on term:

• POST /v3/networkdesign/validate
• POST /v3/networkdesign/buy
• PUT /v3/product/vxc/{productUid}

Acceptable values for term are: 1, 12, 24, 36. If term is not provided when validating and ordering a VXC, it defaults to 1 (No Minimum Term). If term is not provided when updating a VXC, the existing value is not updated.