Skip to navigation
API ReferenceProduct Details

Delete Port (v3)

View as Markdown

Deletes (terminates) the Port by changing the provisioning status.

When the Port is terminated, any services (such as VXCs) attached to the Port are also terminated.

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

The productUid is a required string that identifies the service by the unique product identifier.

The action is a required string that indicates the change in the service. Accepted values are:

  • CANCEL - Cancels service on a Port at the end of the contract term. You can restore the Port before the contract ends.

  • UN_CANCEL - Restores a Port that has been canceled but not reached the end of the contract term.

  • CANCEL_NOW - Stops the service on the Port immediately. You will still be billed for the remainder of your contract and early termination fees apply. The Port cannot be restored.

Note: Terminating a Port on a contract term will result in an early termination fee (ETF) equivalent to 100% of the remainder of the term.

For more information about the product lifecycle and provisioning status, see Monitoring Service Status with the API.

Cancellation Reasons

You customize the Body of the request with the cancellation reason details for terminating a service. Specifying the reason for terminating a service will allow us to understand how we can improve your customer experience.

Note:

  • Ordered in Error or Reordering (SERVICE_ORDERED_IN_ERROR) should be specified if you have upgraded or downgraded the service speed and re-ordered.

  • Reason not Listed (OTHER) provides an optional free text field that allows you to specify a different reason to those listed. This field has a maximum of 400 characters.

  • You can also provide additional details in the free text field for any of the cancellation reasons.

AttributeDescription
cancellation_reason(Optional) The reason for deleting the service.
These options are available:
MOVED_TO_CLOUD_NATIVE_SOL
SERVICE_MOVED
SERVICE_ORDERED_IN_ERROR
PROOF_OF_CONCEPT
PROJECT_ENDED
SWITCHING_PROVIDER
PRICING
PRODUCT_PERFORMANCE
OTHER
cancellation_commentSpecify free text (max. 400 characters) with an additional explanation for the reason the service was terminated.

For more information, see Terminating a Port.

Path parameters

productUidstringRequired
actionstringRequired

Query parameters

terminationDatestringOptional

The termination date for the Megaport Internet connection. (Required - integer)

Request

This endpoint expects an object.
cancellation_commentstringOptional
cancellation_reasonstringOptional

Response

Delete Port (v3) / Delete Port With Cancellation Reason (CANCEL) (v3) / Delete Port With Cancellation Reason (CANCEL NOW) (v3) / Delete Port With Cancellation Reason (CANCEL NOW) (v3) / Delete Port With Cancellation Reason (CANCEL) (v3) / Delete Port (v3) / Delete VXC (v3) / Delete VXC With Cancellation Reason (v3) / Delete VXC (v3) / Delete VXC With Cancellation Reason (v3) / Delete Megaport Internet - With Cancel Reason / Delete Megaport Internet - With Cancel Reason / Delete MCR (v3) / Delete MCR With Cancellation Reason (v3) / Delete MCR (v3) / Delete MCR With Cancellation Reason (v3) / Delete Megaport Internet (v3) / Delete Megaport Internet (v3) / Delete MVE (v3) / Delete MVE With Cancellation Reason (v3) / Delete MVE With Cancellation Reason (v3) / Delete MVE (v3) / Delete IX With Cancellation Reason (v3) / Delete IX With Cancellation Reason (v3) / Update Product Lifecycle Action (v3) / Update Product Lifecycle Action With Cancellation Reason (CANCEL NOW) (v3) / Update Product Lifecycle Action (v3) / Update Product Lifecycle Action With Cancellation Reason (CANCEL NOW) (v3)

messagestringOptional
termsstringOptional