Monitoring Service Status with the API
You can retrieve the status of any Megaport service (such as Port, VXC, MCR, or MVE) with this request available in the Product Details folder of the Postman collection:
GET {baseUrl}/v2/product/{productUid}
The response includes the provisioning 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. Services are no longer returned 30 days after they are decommissioned. | |||
FAILED | The service could not be deployed and is not in the deployment queue. |
Additionally, the response to the /v2/product/
endpoint for any Megaport service includes the current status of the service. The status in the root level up
attribute indicates if the service is up (a value of true) or down (a value of false). This example shows the up
attribute for a VXC.
{
"message": "Found Product 9fbc4f9e-5f59-458e-bb95-6633e77ab121",
"terms": "This data is subject to the Acceptable Use Policy https://www.megaport.com/legal/acceptable-use-policy",
"data": {
"productId": 220451,
"productUid": "9fbc4f9e-5f59-458e-bb95-6633e77ab121",
"productName": "WEST AWS",
"secondaryName": null,
"productType": "VXC",
"rateLimit": 50,
"maximumRate": 10000,
"distanceBand": "METRO",
"provisioningStatus": "LIVE",
"usageAlgorithm": "POST_PAID_VARIABLE",
"createdBy": "cb9c4d7e-4cd2-4f6b-4f4e-89ab263e57e4",
"liveDate": 1733253865042,
"createDate": 1733253767229,
"resources": {
"csp_connection": {
"bandwidth": 50,
"connectType": "AWSHC",
"resource_name": "b_csp_connection",
"resource_type": "csp_connection",
"name": "WEST AWS",
"ownerAccount": "206049248854",
"bandwidths": [
50
],
"connectionId": "dxcon-fftxgi4j"
},
"vll": {
"a_vlan": 2612,
"b_vlan": 2612,
"rate_limit_mbps": 50,
"resource_name": "vll",
"resource_type": "vll",
"up": 1,
"shutdown": false
}
},
"vxcApproval": {
"status": null,
"message": null,
"uid": null,
"type": null,
"newSpeed": null
},
"contractStartDate": 1733253865055,
"contractEndDate": 1735912800000,
"contractTermMonths": 12,
"companyUid": "160408ae-01e4-4cb9-8d57-03a147bd47a8",
"companyName": "Megaport Test",
"locked": false,
"adminLocked": false,
"attributeTags": {},
"up": true,
"shutdown": false,
"cancelable": true,
"aEnd": {
"ownerUid": "160408ae-01e4-4cb9-8d57-03a147bd47a8",
"productUid": "21be60a4-14c8-454f-9636-c6a4ad9f8447",
"productName": "ZW TEST",
"locationId": 147,
"location": "CyrusOne Chandler",
"locationDetail": {
"name": "CyrusOne Chandler",
"city": "Phoenix",
"metro": "Phoenix",
"country": "USA"
},
"vlan": 2612,
"innerVlan": null,
"secondaryName": null,
"connectType": "DEFAULT",
"diversityZone": "red"
},
"bEnd": {
"ownerUid": "605cb840-dfb4-4a05-a171-8bf17757b4a2",
"productUid": "d2b92be4-d85c-4ae5-b511-37c1cfe6e146",
"productName": "US West (N. California) (us-west-1)",
"locationId": 370,
"location": "PhoenixNAP",
"locationDetail": {
"name": "PhoenixNAP",
"city": "Phoenix",
"metro": "Phoenix",
"country": "USA"
},
"vlan": 2612,
"innerVlan": null,
"secondaryName": null,
"connectType": "AWSHC",
"diversityZone": "red"
}
}
}