Skip to content

Changing a VXC Configuration with the API

This topic describes how to change configuration details of an existing VXC. For more information, see PUT Update VXC (v3) in the API reference.

You can change the VXC service name, rate limit, VLAN IDs, contract term, VXC state (enabled or shut down), and A-End and B-End productUids, by updating any of these parameters in the Body of the request:

  "name": "My updated API created VXC",
  "rateLimit": 100,
  "aEndVlan": 301,
  "bEndVlan": 402,
  "shutdown": true,
  "contractStartDate": "",
  "contractEndDate": "",
  "aEndProductUid": "a3ec7ef6-7e29-4a3f-a37d-582b468fd68b",
  "bEndProductUid": "9be424c0-87c7-480e-9d62-57f619bf6e2f"

Before you begin, obtain a valid access token. For more information, see Creating an API Key.

To change the VXC details in the Postman collection

  1. In Postman, expand Connections > Virtual Cross Connects in the left navigation and click PUT Update VXC (v3).

  2. Identify the VXC to update by adding the productUid to the endpoint. Update VXC request

  3. Click the Body tab and update VXC details for name, rate limit, VLAN IDs, contract term, A-End productUid, or B-End productUid.
    Change the productUid if you want to move the A-End or B-End of the VXC.
    The update request only needs to include the parameters you want to change.
    This example changes the following values.
    Update VXC request

  4. Click Send.
    The changes will be reflected in the Portal within two minutes.

Helpful references

Last update: 2024-04-15