Cross Connect APIs allows contract owners, administrators, and authenticated users with the required permissions to create a cross connect and associate it with VDCs via the API.
To associate a Cross Connect with your VDC and the configured private LAN, you can perform the following API calls:
POST
creates a LAN and connects it to a Cross Connect in a single API call.
PUT
or PATCH
can be used to update the corresponding /lan
resource.
The following is an example of a PUT
operation:
202 Successful operation
Prerequisite: Only contract administrators, owners, and users with createPcc privilege can create and manage Cross Connects via the API. You can also set User privileges in the DCD. For more information, see .
For more information about the request and response fields, see .
Prerequisite: Only contract administrators, owners, and users with createPcc privilege can create and manage Cross Connects via the API. You can also set User privileges in the DCD. For more information, see .
Note: To connect a LAN to a Cross Connect, you must use the /lan
endpoint. For more information about how to create LANs and associate them with a Cross Connect, see .
For more information about the request and response fields, see .
For more information, see and .
Learn how to set User privileges for Cross Connect via the API.
Learn how to create a Cross Connect via the API.
Learn how to associate a LAN with the Cross Connect via the API.
Learn how to update a Cross Connect via the API.
Learn how to delete a Cross Connect via the API.
Prerequisite: You need administrative privileges to create and assign user privileges using the Cloud API.
To set user privileges via the Cloud API for managing Cross Connect, follow these steps:
Authenticate to the Cloud API using your API credentials.
Create a user using the POST /cloudapi/v6/um/users
endpoint.
Set the following required parameters for the user: user's name
, email address
, and password
.
Create a group using the POST /cloudapi/v6/um/groups
endpoint.
Set createPcc
privilege to true
.
Assign the user to the created group using POST /cloudapi/v6/um/groups/{groupId}/users
endpoint.
Note: Remember to provide the user ID in the request body as shown in the example: id: <userID>
Result: The Create Cross Connects privilege is granted to the user.
Prerequisite: Only contract administrators, owners, and users with createPcc privilege can create and manage Cross Connects via the API. You can also set User privileges in the DCD. For more information, see Set User Privileges for Cross Connect.
To delete a Cross Connect via the API, perform a DELETE
request with the ID of the respective Cross Connect.
202 Successful operation
For more information about the request and response fields, see Delete Cross Connects.