Update Bandwidth/Speed of a Connection
Step 1: Authenticate
Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication.
Refer to Generating Client ID and Client Secret under the Getting Access Token section for instructions on how to create client ID and client secret and refer to Requesting Access and Refresh tokens section for instructions on how to call Oauth API to validate and authenticate your credentials.
If you are unaware of your user credentials for Equinix Fabric, contact your local Equinix Service Desk.
Step 2: Update Bandwidth/Speed
Update the speed of the connection using the below API.
PATCH /connections/{uuid} | |
---|---|
Method | PATCH |
URL or Endpoint | /ecx/v3/l2/connections/{uuid} |
Headers | Authorization, Content-Type |
Query Parameters | action |
Body Parameters | speed, speedUnit |
The connection speed can only be updated for Microsoft Azure, Oracle FastConnect, Google, and Enterprise connections.
Uuid is an identifier unique to each connection.
If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens section under the Getting Access Token.
The following screenshots show a sample curl request and JSON response to update the speed of a connection with UUID 9999a8-0e07-44d0-944c-88a25d8d28f7
curl -X
PATCH "https://api.equinix.com/ecx/v3/l2/connections/9999a8-0e07-44d0-944c-88a25d8d28f7?action=update"
-H "content-type: application/json"
-H "Authorization: Bearer qwErtY8zyW1abcdefGHI"
-d '{
"speed":50,
"speedUnit":"MB"
}'
The description of the request payload is as follows:
URL Parameter Name | Mandatory | Type | Example | Applicable Values | Description |
---|---|---|---|---|---|
UUID | Yes | string | 9999a8-0e07-44d0-944c-88a25d8d28f7 | The Equinix-assigned ID of the connection. |
Query Parameter Name | Mandatory | Type | Example | Applicable Values | Description |
---|---|---|---|---|---|
action | Yes | string | Update | "Approve" "Reject" "Update" | The action to perform on the connection. |
Body Parameter Name | Mandatory | Type | Example | Description |
---|---|---|---|---|
speed | Yes | integer | 50 | Speed/Bandwidth you would like to allocate to the connection |
speedUnit | Yes | string | MB | Unit of the speed or bandwidth. |
{
"message": "Connection updated Successfully",
"primaryConnectionId": "9999a8-0e07-44d0-944c-88a25d8d28f7",
"status": "submitted"
}
The description of the response payload is as follows:
Field Name | Type | Example values | Description |
---|---|---|---|
message | string | Connection updated Successfully | Indicates the status of the PATCH API call. |
primaryConnectionID | string | 9999a8-0e07-44d0-944c-88a25d8d28f7 | Indicates the primary connection ID. |
If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Fabric Portal access.
In order for the speed to be updated, your seller must accept this request and make the relevant changes at the sellers' end. Once this is done, you can verify the speed using the API GET Connections{uuid}