Monitoring Service Status with the API

You can retrieve the status of any Megaport service (such as a Port, VXC, or MCR) with this request:

GET {API Server URL}/v2/product/{productUid}

The response includes the status of the service in the provisioningStatus field. The provisioningStatus field can have the following values:

Provisioning Status Description Port MCR VXC
NEW Only for preordering Ports. This status indicates the service order has been accepted and is waiting on the infrastructure to be available. This status applies to Port preorders only. N/A N/A
DEPLOYABLE The service order has been confirmed and is waiting for deployment. Services are typically in this state for 1-2 minutes.
CONFIGURED The deployment has completed and the service is configured on the network.
LIVE The meaning of this status depends on the product. The service has been detected as live on the network. Light has been detected on the Port, meaning a cross connect has been attached and the Port activated. The transition from CONFIGURED to LIVE is instantaneous. The transition from CONFIGURED to LIVE is instantaneous.
CANCELLED, CANCELLED_PARENT Termination of the service has been requested. Services are typically in this state for 1-2 minutes unless a future date has been set for termination. Ports provide two options: 1) Terminate now 2) Terminate in 30 days. MCRs only support terminate “now”. VXCs can be individually terminated “now” or are terminated as part of terminating the attached Port or MCR. VXCs attached to Ports that are set to terminate in 30 days are terminated when the Port is terminated.
DECOMMISSIONED The service has been decommissioned from the network.
FAILED The service could not be deployed and is not in the deployment queue.

Additionally, the response to the /v2/product/ endpoint for a VXC includes the current status of a VXC. The status in the data.resources.vll.up attribute indicates if the VXC is up (a value of 1) or down (a value of 0).

"resources": {
            "vll": {
                "b_vlan": 3639,
                "description": "VXC between Megaport Lab 10G MEGAPORT at NextDC S1 and Megaport Lab 10G MCR at Equinix SY1",
                "id": 145555,
                "name": "vll187090",
                "rate_limit_mbps": 10000,
                "resource_name": "vll",
                "resource_type": "vll",
                "up": 1

Last update: