Skip to navigation

Update VXC (v3)

View as Markdown

Updates editable information for a VXC.

The productUid identifies the VXC.

Tip: Use the /v2/product endpoint to determine the productUid.

The changes are defined in the Body of the request. Only include the parameters that you want to update. For a VXC, you can update the following parameters:

  • name - Customer name for the connection - this name appears in the Portal.

  • rateLimit - A new speed for the connection.

  • aEndVlan - A unique VLAN ID for this connection. Values can range from 2 to 4093. If this value is 0, the system allocates a valid VLAN.

  • bEndVlan - A unique VLAN ID for this connection. Values can range from 2 to 4093. If this value is 0, the system allocates a valid VLAN.

  • term - Set up a term for this VXC. Note that there are rules for terms. See VXC Terms below for more information.

  • costCentre - A customer reference number to be included in billing information and invoices

  • aEndProductUid - When moving a VXC, this is the new A-End for the connection.

  • bEndProductUid - When moving a VXC, this is the new B-End for the connection.

  • aVnicIndex - When moving a VXC for an MVE, this is the new A-End vNIC for the connection.

  • bVnicIndex - When moving a VXC for an MVE, this is the new B-End vNIC for the connection.

  • isApproved - Define whether the VXC is approved or rejected via the Megaport Marketplace. Set to true (Approved) or false (Rejected).
    Note: Valid only if there is an order pending approval (either new marketplace request or speed change). If there are no orders pending approval and isApproved is sent in the request, the API will return an error.

  • shutdown - Temporarily shut down and re-enable the VXC. Valid values are true (shut down) and false (enabled). If not provided, it defaults to false (enabled).

For more information, see Changing a VXC Configuration with the API.

Note: You can update a product only when its provisioning status is CONFIGURED or LIVE.

VXC Terms

You can update the term of the VXC by updating the term field.

The following rules apply to updating VXC terms:

  • If validation fails, the term defaults to No Minimum Term, contractTermMonths:1.

  • The speed cannot be changed when the VXC is on term.

  • You can change the speed only if the VXC is on No Minimum Term, if the term has expired, or if reterming to a longer term.

  • If you are updating a VXC on term, you can only reterm to a higher term. If you need to change the speed, you can only change it to a higher rate limit.

  • If you are updating an expired VXC on term, any term and/or speed can be selected.

  • You cannot change a VXC from a term (12/24/36 month) to month-to-month/No Minimum Term unless the term has expired.

  • You cannot reterm a VXC if the service is on a non-standard price.

  • You can move or shut down VXCs on term.

Move VXC

You can move a VXC by updating the A-End or B-End or both, using the fields aEndProductUid and bEndProductUid. When moving a VXC for an MVE, you can also select the vNICs at the A-End and B-End using the fields aVnicIndex and bVnicIndex.

The following rules determine where and how you can move a VXC:

  • The new Port can be in a different location but must be in the same metro area.

  • The new Port must be of the same type. For example, MEGAPORT to MEGAPORT, MCR to MCR, or MVE to MVE.

  • The configured speed of each VXC must be no greater than the speed of the destination Port. If downgrading, it might be necessary for you to lower the speed of the VXC before requesting the move.

  • There must not be an IP address or VLAN conflict. The updated services are checked as if a new service is being ordered. For example, an untagged VLAN can’t be moved to a service that already has an untagged VLAN.

  • The services being moved must have different VLAN IDs from any services already on the destination.

If the VXC move is invalid, the move will fail.

For more information, see Moving VXCs and Moving a VXC and IX with the API.

Path parameters

productUidstringRequired

Request

This endpoint expects an object.
aEndInnerVlandoubleOptional
aEndVlandoubleOptional
bEndInnerVlandoubleOptional
costCentrestringOptional
namestringOptional
rateLimitdoubleOptional
termdoubleOptional

Response

Update VXC (v3) / Move VXC (v3) / Move VXC for MVE - Update vNICs on Both Ends (v3) / Move VXC for MVE - Change B-End to Connect to MVE with Multiple vNICs (v3) / Shut Down VXC (v3) / Re-enable VXC (v3) / Update VXC Term (v3) / Move VXC (v3) / Move VXC for MVE - Change B-End to Connect to MVE with Multiple vNICs (v3) / Update VXC (v3) / Update VXC Term (v3) / Move VXC for MVE - Update vNICs on Both Ends (v3) / Shut Down VXC (v3) / Re-enable VXC (v3) / Update Megaport Internet (v3) / Update Megaport Internet (v3) - 12 Month Contract Term / Update Megaport Internet (v3) - 24 Month Contract Term / Update Megaport Internet (v3) - Move / Update Megaport Internet (v3) - Shut Down / Update Megaport Internet (v3) - Re-enable / Update Megaport Internet (v3) / Update Megaport Internet (v3) - 12 Month Contract Term / Update Megaport Internet (v3) - Re-enable / Update Megaport Internet (v3) - Shut Down / Update Megaport Internet (v3) - Move / Update Megaport Internet (v3) - 24 Month Contract Term / Update AWS Hosted VIF VXC (v3) / Update AWS Hosted VIF VXC (v3) / Update Azure VXC (v3) / Update Azure VXC (v3) / Update AWS Hosted VIF VXC (v3) / Update AWS Hosted VIF VXC (v3) / Update Azure VXC (v3) / Update Azure VXC (v3) / Update AWS Hosted VIF VXC (v3) / Update AWS Hosted VIF VXC (v3) / Update Azure VXC (v3) / Update Azure VXC (v3) / Update Google VXC (v3) / Update Google VXC (v3) / Update VXC for MCR (v3) - Rate limit and tags / Update VXC for MCR (v3) - Various changes / Update VXC for MCR (v3) - Rate limit and tags / Update VXC for MCR (v3) - Various changes / Update Megaport Internet (v3) / Update Megaport Internet (v3) - 12 Month Contract Term / Update Megaport Internet (v3) / Update Megaport Internet (v3) - 12 Month Contract Term

dataobjectOptional
messagestringOptional
termsstringOptional