Skip to main content
Index

CrossConnects (V2 Beta)

Crossconnects (V2 Beta) APIs allow an authenticated user with the required permissions to do the following: create a cross connects order request, and update the cross connects order.

 

To create a cross connects order, see Order cross connects (V2 Beta) under the How to Guide. All other methods can be found below.

PATCH CrossConnects {orderId}

PATCH /crossConnects/{orderId}

 Method  PATCH
 URL or End Point  /colocations/v2/orders/crossConnects/{orderId}
 Headers  Authorization, Content-Type
 Query Parameters  Not applicable
 Body

 {contacts [type, {registeredUsers [...]}]}

 

This method partially updates a specific cross connects order that is not cancelled or completed. To update this cross connects order, the authenticated user must have permissions to view all users' requests, or they must be the ordering or technical contact for this cross connects order. Currently, the user can only update the notification contacts of the order. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

 

If you would like to update any additional information on the order besides the notification contacts, you may add notes to the order with POST Orders {orderId} Notes

 

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

The following screenshot shows a sample curl request to update the notification contacts of the cross connects order. 

 

curl -X

PATCH "https://api.equinix.com/colocations/v2/orders/crossConnects/1-188243137021"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

-d '{
   "contacts": [
    {
      "registeredUser": [
        "siripala@acme.com",
        "somchai9"
      ],
      "type": "NOTIFICATION"
    }
  ]
}'

 

The description of the URL parameters is as follows:

 

URL Parameter Name Mandatory Type Example Description
orderId Yes string 1-188243137021

Order identifier (order ID).

 

Order ID was returned in the response header 'Location' after the cross connects order was created. For example, 'orders/1-188243137021' would have been returned as the URL of the newly created cross connects order. This order ID is also the cross connect order number in the Equinix Customer Portal.

 

If you are not sure of your order ID, see How to retrieve order history? under the How to Guide. 

 

The description of the body parameters is as follows:

 

Body Parameter Name Mandatory Type Example Applicable Values Description
type Yes string NOTIFICATION NOTIFICATION

Defines the registered contact type.

 

Type - Description

NOTIFICATION - Notification contact

contacts Yes

array

[object]

   

Contacts array consists of the notification contact object. The contacts object contains the following parameters: registeredUsers, and type. 

 

Limit: 1 object

 

This notification contacts object will serve as the latest list of registered users to receive notifications for this order. All registered users included in this object will completely replace the existing list of users. If you would like to add more users to the existing list, ensure that the existing list of registered usernames are not left out in this object. 

registeredUsers Yes

array

[string]

siripala@acme.com,
somchai9
 

List of Equinix Customer Portal usernames of the registered contacts. Each string in the array represents one contact's username.

 

Equinix Customer Portal user's status must be approved, active, or locked. If the user's status is not any of these, the request will fail. 

 

Limit for notification contacts: 1 to 10 strings. 

 

Cross connects order update is successful when an HTTP code of 200 is returned, and the following response header is returned. There is no response body.

 

HTTP Response Header Name

Description
Location

URL of the cross connects order. 

 

Example: /orders/{orderId}

 

'orderId' is the order identifier (ID). This is important to retrieve, update, cancel, or add notes to the order. The cross connects order ID is also known as the cross connect order number in the Equinix Customer Portal.

 

If you get “Insufficient permissions” error, contact your Master Administrator.