Create Cross Connect Order
A cross connect is a point-to-point cable link between two customers in the same or different Equinix International Business Exchange™ (IBX®) data center. Cross connects can only be ordered by an Equinix Customer Portal user with Cross Connect & Intra-Facility Cables ordering permission. The types of cross connects currently supported by Equinix Customer Portal APIs may be found here.
For more information on cross connects, see Cross Connect.
Order cross connects (V2)
Step 1: Authenticate
Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication.
Refer to Generating Client ID and Client Secret under Getting Access Token section for instructions on how to create client ID and client secret and refer to Requesting Access and Refresh tokens for instructions on how to call Oauth API to validate and authenticate your credentials.
If you are unaware of your user credentials for Equinix Customer Portal, contact your local Equinix Service Desk.
Step 2: Get Cross Connects Details
To get cross connect details, the user must have Cross Connect & Intra-Facility Cables ordering permission. If you are unaware of your user permissions, contact your Master Administrator.
2a) Get the location information for the starting point of your cross connect (A-side)
Retrieve all your permitted location information.
Determine the exact IBX, cage ID, and cabinet ID for your A-side criteria. Ensure all your desired cross connects belong to the same A-side IBX, and cage.
In the subsequent steps, you will need these values to get your required A-side and Z-side details.
If you would like to patch your equipment for this cross connect, the cabinet ID will be passed in your request body in Step 4 for the following A-side parameter: cabinetId.
Refer to GET Locations under the API Reference section for instructions on how to get your permitted location information. You may skip this step if you already know the location information for your A-side.
2b) Get connection services information for your A-side criteria
Retrieve all the connection services information for your preferred location.
Determine which connection service, media type, connector type, and protocol type are available in the selected IBX.
These values will also be passed in the request body in Step 4 for the following A-side parameters: connectionService, mediaType, connectorType, protocolType.
Refer to GET ConnectionServices under the API Reference section for instructions on how to get your connection services information. You may skip this step if you already know the connection services information for your A-side.
2c) Get patch panel information for your A-side criteria
Retrieve a list of your available patch panels.
Determine the preferred patch panel ID for your A-side criteria.
This value will be passed in your request body in Step 4 for the following A-side parameter (part of patchPanel object): id.
You will also need this value if you would like to retrieve the available ports and compatible connection services specific to your patch panel. The values retrieved here can be passed in your request body in Step 4 for the following A-side parameters (part of patchPanel object): portA, portB.
Refer to GET PatchPanels under the API Reference section for instructions on how to retrieve available patch panels. You may skip this step if you already know the patch panel ID for your A-side.
If you would like to get more information on your patch panel such as the available ports and all its connection services, see GET PatchPanels {patchPanelId} under the API Reference section.
2d) Get service providers information (end point of the cross connect or Z-side)
Retrieve a list of your available service providers.
Determine your service provider's account number.
In the subsequent steps, you will need this value to get your required Z-side details.
Refer to GET Providers under the API Reference section for instructions on how to get the service provider's information. You may skip this step if you already know the service provider's information.
2e) Get your Z-side criteria details by repeating steps 2a to 2c
Retrieve all the same details from steps 2a to 2c for the Z-side criteria. Ensure all your desired cross connects belong to the same Z-side provide, IBX, cage.
These values will be passed in the request body in Step 4 for the following Z-side parameters: connectorType, patchPanel.
You may skip this step if you already know your Z-side criteria details.
2f) Get Circuit ID for your Z-side criteria
Retrieve the Circuit ID cable reference number from your Z-side for verification purposes.
This value will be passed in the request body in Step 4 for the following Z-side parameter: circuitId.
Refer to your service provider for their Circuit ID cable reference number. You may skip this step if you already know the Circuit ID.
2g) For multiple quantities of cross connects, repeat steps 2a to 2f to get the necessary A-side and Z-side information.
Retrieve the necessary A-side and Z-side criteria details for your multi-quantity cross connects.
Multiple cross connects can only be ordered together when they originate from the same A-side IBX, cage, and account, and end at the same Z-side provider, IBX and cage.
You may skip this step if you already know your multiple A-side and Z-side criteria details.
Step 3: Get Contact Information
If you are the only technical and notification contact for this order, skip this step and proceed to Step 4.
3a) Identify usernames
Identify the usernames you want to include as technical and notification contacts for this order.
To verify if the username belongs to your intended user, proceed to Step 3b.
When you are certain this is the correct username, proceed to Step 4, where this value will be passed in the request body for the following parameter in the contacts array: registeredUsers.
Refer to GET Users under the API Reference section for instructions on how to get all your users. You may skip this step if you know this username.
3b) Verify usernames
Ensure the user profile details match the details of your intended user.
Refer to GET Users {username} under the API Reference section for instructions on how to get your user profile. You may skip this step if you are certain this is the intended user.
Step 4: Order Cross Connects
| POST /crossConnects | |
|---|---|
| Method | POST |
| URL or End Point | /colocations/v2/orders/crossConnects |
| Headers | Authorization, Content-Type |
| Query Parameters | Not applicable |
| Body Parameters | details [{aSide {connectionService, mediaType, protocolType, connectorType, mediaConverterRequired, ifcCircuitCount, patchPanel {id, portA, portB}, patchEquipment {cabinetId, connectorType, details, port}}, zSide {providerName, ibx, connectorType, circuitId, patchPanel {id, portA, portB}, loaAttachmentId, notificationEmail}, diverseConnections {type, serialNumber, aSide {patchPanel {id, portA, portB}, connectorType, mediaConverterRequired, ifcCircuitCount, patchEquipment {cabinetId, connectorType, details, port}}, zSide {patchPanel {id, portA, portB}, connectorType, circuitId}}, verifyLink, circuitDeliveryDate, submarineEngineerRequired}], expediteDateTime, customerReferenceId, description, attachments [{id, name }], purchaseOrder {type, number, amount, startDate, endDate, attachmentId}, contacts [{type, registeredUsers […]}, {type, firstName, lastName, availability, timezone, details [{type, value }]}] |
This method creates a cross connects order request between two Equinix customers (A-side and Z-side) in the same or different IBX locations. The A-side customer initiates this request to connect to the Z-side provider. Only an authenticated user with Cross Connect & Intra-Facility Cables ordering permissions may create a cross connects request. Single or multiple quantities of cross connects may be ordered in a single request.
These multi-quantity cross connects can only be submitted in one order request if they fulfill the following criteria:
- All cross connects start from the same A-side IBX, cage and account
- All cross connects end at the same Z-side provider, IBX and cage
- Total number of cross connects in one request does not exceed 10
If the cross connects you want to order do not fulfill this criteria, you need to submit separate order requests.
Currently, standard cross connect and standard cross connect with diverse cross connect are supported. Diverse cross connect can serve as a backup to standard cross connect in the event of cable failure.
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 are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Access Token section.
STANDARD CROSS CONNECT
The following screenshots show sample curl requests based on the following scenarios:
(A) An order for cross connects from an account in a single account cage to an existing service provider without LOA attachment (minimum required information)
(B) An order for cross connects from an account in a cage with multiple accounts to an existing service provider without LOA attachment (minimum required information)
(C) An order for cross connects from an account in a single account cage to an existing service provider with LOA attachment (minimum required information)
(D) An order for cross connects from an account in a cage with multiple accounts to an existing service provider with LOA attachment (minimum required information)
(E) An order for cross connects from an account in a single account cage to a new service provider with LOA attachment (minimum required information)
(F) An expedited order for cross connects from an account in a cage with multiple accounts to a new service provider with LOA attachment, along with other attachments, information, and requests
The minimum required information is illustrated for each of these scenarios, and the final scenario, (F), includes all the available properties that can be passed with any of these scenarios.
(A) An order for cross connects from an account in a single account cage to an existing service provider without LOA attachment (minimum required information)
A cross connects order from an account in a single account cage to an existing service provider without a Letter of Authorization (LOA) attached, minimally requires the A-side patch panel ID and full connection services details, and the Z-side connector type, circuit ID, and patch panel ID. One object in the details array represents one cross connect. When ordering multi-cross connects, pass multiple objects in the details array.
curl -X
POST "https://api.equinix.com/colocations/v2/orders/crossConnects"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"
-d '{
"details": [
{
"aSide": {
"connectionService": "SINGLE_MODE_FIBER",
"mediaType": "SINGLE_MODE_FIBER",
"protocolType": "10_GIG_ETHERNET",
"connectorType": "FC",
"patchPanel": {
"id": "CP:0104:1199890"
}
},
"zSide": {
"connectorType": "LC",
"circuitId": "1-12312312",
"patchPanel": {
"id": "PP:0104:1190123"
}
}
}
]
}'
(B) An order for cross connects from an account in a cage with multiple accounts to an existing service provider without LOA attachment (minimum required information)
A cross connects order from an account in a cage with multiple accounts to an existing service provider without Letter of Authorization (LOA) attached, minimally requires the A-side patch panel ID, and full connection services details, and the Z-side connector type, circuit ID, and patch panel ID. One object in the details array represents one cross connect. When ordering multi-cross connects, pass multiple objects in the details array.
curl -X
POST "https://api.equinix.com/colocations/v2/orders/crossConnects"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"
-d '{
"details": [
{
"aSide": {
"connectionService": "SINGLE_MODE_FIBER",
"mediaType": "SINGLE_MODE_FIBER",
"protocolType": "10_GIG_ETHERNET",
"connectorType": "FC",
"patchPanel": {
"id": "CP:0104:1199890"
}
},
"zSide": {
"connectorType": "LC",
"circuitId": "1-12312312",
"patchPanel": {
"id": "PP:0104:1190123"
}
}
}
]
}'
(C) An order for cross connects from an account in a single account cage to an existing service provider with LOA attachment (minimum required information)
A cross connects order from an account in a single account cage to an existing service provider with LOA attached, minimally requires the A-side patch panel ID and full connection services details, the Z-side patch panel ID, and LOA attachment ID. One object in the details array represents one cross connect. When ordering multi-cross connects, pass multiple objects in the details array.
Before creating an order with an attachment, call the POST Attachments File under the API Reference section.
curl -X
POST "https://api.equinix.com/colocations/v2/orders/crossConnects"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"
-d '{
"details": [
{
"aSide": {
"connectionService": "SINGLE_MODE_FIBER",
"mediaType": "SINGLE_MODE_FIBER",
"protocolType": "10_GIG_ETHERNET",
"connectorType": "FC",
"patchPanel": {
"id": "PP:0501:1093542"
}
},
"zSide": {
"patchPanel": {
"id": "PP:0104:1190123"
},
"loaAttachmentId": "fcb2k8763-2947-456e-8d68-f280753d60ba"
}
}
]
}'
(D) An order for cross connects from an account in a cage with multiple accounts to an existing service provider with LOA attachment (minimum required information)
A cross connects order from an account in a cage with multiple accounts to an existing service provider with LOA attached, minimally requires the A-side patch panel ID and full connection services details, the Z-side patch panel ID, and LOA attachment ID. One object in the details array represents one cross connect. When ordering multi-cross connects, pass multiple objects in the details array.
Before creating an order with an attachment, call the POST Attachments File under the API Reference section.
curl -X
POST "https://api.equinix.com/colocations/v2/orders/crossConnects"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"
-d '{
"details": [
{
"aSide": {
"connectionService": "SINGLE_MODE_FIBER",
"mediaType": "SINGLE_MODE_FIBER",
"protocolType": "10_GIG_ETHERNET",
"connectorType": "FC",
"patchPanel": {
"id": "PP:0501:1093542"
}
},
"zSide": {
"patchPanel": {
"id": "PP:0104:1190123"
},
"loaAttachmentId": "fcb2k8763-2947-456e-8d68-f280753d60ba"
}
}
]
}'
(E) An order for cross connects from an account in a single account cage to a new service provider with LOA attachment (minimum required information)
A cross connects order from an account in a single account cage to a new service provider with LOA attached, minimally requires the A-side patch panel ID and full connection services details, and the Z-side provider name, IBX, and LOA attachment ID. One object in the details array represents one cross connect. When ordering multi-cross connects, pass multiple objects in the details array.
Before creating an order with an attachment, call the POST Attachments File under the API Reference section.
curl -X
POST "https://api.equinix.com/colocations/v2/orders/crossConnects"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"
-d '{
"details": [
{
"aSide": {
"connectionService": "SINGLE_MODE_FIBER",
"mediaType": "SINGLE_MODE_FIBER",
"protocolType": "10_GIG_ETHERNET",
"connectorType": "FC",
"patchPanel": {
"id": "CP:0104:1199890"
}
},
"zSide": {
"providerName": "Acme Corporation",
"ibx": "AM1",
"loaAttachmentId": "fcb2k8763-2947-456e-8d68-f280753d60ba"
}
}
]
}'
All the scenarios up to this point have illustrated the minimum required information to include in different request payloads for the following types of cross connects order requests:
- Orders originating from private or shared cabinets
- Orders including or not including LOA attachments
- Orders ending at existing or new providers.
In the following scenario, the cross connect order will be from an account with a shared cabinet to a new service provider with an LOA attachment, but it will be including all the additional attachments, information, and requests that may be included in any other scenario.
(F) An expedited order for cross connects from an account in a cage with multiple accounts to a new service provider with LOA attachment, along with other attachments, information, and requests
A cross connects order from an account in a cage with multiple accounts to a new service provider with LOA attached, minimally requires the A-side patch panel ID and full connection services details, and the Z-side provider name, IBX, and LOA attachment ID. One object in the details array represents one cross connect. When ordering multi-cross connects, pass multiple objects in the details array.
This order is also an expedited order request that includes: specified port details for the A-side and Z-side criteria; additional Smart Hands request to patch equipment for the A-side; additional Smart Hands request to verify the connection; Z-side email address to notify them when the connection is established; additional request for submarine cable engineering support; circuit delivery date; customer reference information; additional descriptions and attachments to support this order; purchase order information to be applied to this order; and technical and notifications contacts that are different from the ordering contact.
Before creating an order with an attachment, call the POST Attachments File under the API Reference section.
curl -X
POST "https://api.equinix.com/colocations/v2/orders/crossConnects"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"
-d '{
"details": [
{
"aSide": {
"connectionService": "SINGLE_MODE_FIBER",
"mediaType": "SINGLE_MODE_FIBER",
"protocolType": "10_GIG_ETHERNET",
"connectorType": "FC",
"mediaConverterRequired": false,
"ifcCircuitCount": 2,
"patchPanel": {
"id": "CP:0104:1199890",
"portA": 12,
"portB": 13
},
"patchEquipment": {
"cabinetId": "SG1:01:00EQ00:0001",
"connectorType": "FC",
"details": "Refer to attachment for patching details.",
"port": 10
}
},
"zSide": {
"providerName": "Acme Corporation",
"ibx": "PE2",
"connectorType": "LC",
"circuitId": "1-12312312",
"patchPanel": {
"id": "PP:0104:1190123",
"portA": 1,
"portB": 2
},
"loaAttachmentId": "fcb2k8763-2947-456e-8d68-f280753d60ba",
"notificationEmail": "johndoe@acme.com"
},
"verifyLink": true,
"circuitDeliveryDate": "2020-10-09T10:00:22.395Z",
"submarineEngineerRequired": true
}
],
"expediteDateTime": "2020-10-10T06:30:22.395Z",
"customerReferenceId": "EQX_CC_20201010",
"description": "Please refer to attachment for full details for this cross connects order.",
"attachments": [
{
"id": "85d9660a-f877-405a-b38e-8e61a4f77f44",
"name": "OrderInstructions.docx"
}
],
"purchaseOrder": {
"type": "NEW",
"number": "EQXPO_Ref9654284",
"amount": 10000,
"startDate": "2020-10-01",
"endDate": "2021-09-30",
"attachmentId": "56d10de6-f2c0-4edd-ba29-b70736aa2093"
},
"contacts": [
{
"type": "NOTIFICATION",
"registeredUsers": [
"john_doe",
"john_doe1"
]
},
{
"type": "TECHNICAL",
"firstName": "Jane",
"lastName": "Doe",
"availability": "WORK_HOURS",
"timezone": "America/New_York",
"details": [
{
"type": "EMAIL",
"value": "janedoe@acme.com"
},
{
"type": "PHONE",
"value": "+1-987654321"
},
{
"type": "MOBILE",
"value": "+1-912345678"
}
]
}
]
}'
STANDARD CROSS CONNECT with DIVERSE CROSS CONNECT
A Diverse Campus Cross Connect is a secondary deployment of a Campus Cross Connect that is systematically paired with a primary Campus Cross Connect and can serve as its backup in the event of a cable failure.
The following rules apply to diverse cross connect:
- Two different IBXs are required to establish a diverse connection
- Only some IBXs allow the diverse connection function
- Only single orders are applicable for diverse cross connects
- Diverse connections are not supported for multi quantity cross connect orders
The following screenshots show sample curl requests based on the following scenarios:
(A) An order for a new diverse connection for cross connect
(B) An order for an existing diverse connection for cross connect
(A) New Diverse Connection
A new diverse cross connect order from an account in a single account cage to an existing service provider, minimally requires the A-side patch panel ID and connector type, and the Z-side connector type, circuit ID, and patch panel ID. One object in the details array represents one cross connect.
curl -X
POST "https://api.equinix.com/colocations/v2/orders/crossConnects"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"
-d '{
"details": [
{
"aSide": {
"connectionService": "SINGLE_MODE_FIBER",
"mediaType": "SINGLE_MODE_FIBER",
"protocolType": "10_GIG_ETHERNET",
"connectorType": "SC",
"patchPanel": {
"id": "PP:0000:1126899"
}
},
"zSide": {
"patchPanel": {
"id": "CP:0218:0102:13008148"
},
"circuitId": "1-12312312",
"connectorType": "SC"
},
"verifyLink": true,
"circuitDeliveryDate": "2022-03-04",
"submarineEngineerRequired": true,
"diverseConnections": {
"type": "NEW",
"aSide": {
"patchPanel": {
"id": "PP:0000:1126899"
},
"connectorType": "ST"
},
"zSide": {
"patchPanel": {
"id": "CP:0218:0102:13008148"
},
"circuitId": "1293012000",
"connectorType": "SC"
}
}
}
]
}'
(B) Existing Diverse Connection
An existing diverse cross connect order from an account in a single account cage to an existing service provider, minimally requires serial number of cross connect. The A-side and the Z-side and not required. One object in the details array represents one cross connect.
curl -X
POST "https://api.equinix.com/colocations/v2/orders/crossConnects"
-H "content-type: application/json"
-H "authorization: Bearer qwErtY8zyW1abcdefGHI"
-d '{
"details": [
{
"aSide": {
"connectionService": "SINGLE_MODE_FIBER",
"mediaType": "SINGLE_MODE_FIBER",
"protocolType": "10_GIG_ETHERNET",
"connectorType": "SC",
"patchPanel": {
"id": "PP:0000:1126899"
}
},
"zSide": {
"patchPanel": {
"id": "CP:0218:0102:13008148"
},
"circuitId": "1-12312312",
"connectorType": "SC"
},
"verifyLink": true,
"circuitDeliveryDate": "2022-03-04",
"submarineEngineerRequired": true,
"diverseConnections": {
"type": "EXISTING",
"serialNumber": "20783335"
}
}
]
}'
The description of the body parameters is as follows:
When 'Conditional' is indicated for a Body Parameter, refer to Description for further details.
| Body Parameter Name | Mandatory | Type | Example | Applicable Values | Description |
| details | Yes | array [objects] | List of cross connects order details. Each cross connect object represents one cross connect, and comprises the following parameters where applicable: aSide, zSide, diverseConnections, verifyLink, circuitDeliveryDate, submarineEngineerRequired. Limit: Up to 10 cross connect objects. If your desired cross connects do not fulfil the following criteria, you need to submit separate order requests for these cross connects.
| ||
| aSide | Yes | object | A-side details for the cross connect. Each A-side details object comprises the following parameters where applicable: connectionService, mediaType, protocolType, connectorType, mediaConverterRequired, ifcCircuitCount, patchPanel, patchEquipment. | ||
| connectionService | Yes | string | SINGLE_MODE_FIBER | Click here for applicable values. | Preferred A-side connection service. |
| mediaType | Yes | string | SINGLE_MODE_FIBER | A-side media type. | |
| protocolType | Yes | string | 10_GIG_ETHERNET | A-side protocol type. | |
| connectorType | Yes | string | FC | A-side connector type. For fast provisioning patch panel, the A-side connector type must be LC. See GET PatchPanels under the API Reference section for more information on fast provisioning type. | |
| mediaConverterRequired | No | boolean | false | true, false | Requirement for media converter. If 'true', media converter is required. If 'false', otherwise. Default value: falseMedia converters are not applicable to single mode fiber connections. You should exclude this if your connection service is 'Single-Mode Fiber'. Cross connect installations that require a media converter due to distance will be held unless 'true' is selected. |
| ifcCircuitCount | No | integer | 2 | Use this field to request an intra-facility cable IFC with this order. Note that there might be a delay in the fulfilment of Cross Connect as it is pending intra-facility cabling. Limit: 1 to 48 | |
| patchPanel | Yes | object | A-side patch panel details. This object comprises the following parameters where applicable: id, portA, portB. | ||
| id | Yes | string | PP:0104:1190123 | A-side patch panel ID. | |
| portA | No | number | 12 | Port A of the patch panel to use. For more information about ports management, see Patch Panel: Ports Management in the Appendix. | |
| portB | No | number | 13 | Port B of the patch panel to use. For more information about ports management, see Patch Panel: Ports Management in the Appendix. | |
| patchEquipment | No | object | Device information that Equinix requires to install the cross connect from demarcation panel to customer equipment, if you need to have your equipment patched. This object comprises the following parameters where applicable: cabinetId, connectorType, details, port. Smart Hands fees will apply for providing this extension. | ||
| cabinetId | Conditional | string | SG1:01:00EQ00:0001 | ID of cabinet where customer equipment for patching is located. This must belong to the specific A-side cage used in this cross connect. This is mandatory when equipment patching is required. | |
| connectorType | Conditional | string | FC | Click here for applicable values. | Device connector type to facilitate cross connect. This is mandatory when equipment patching is required. |
| details | Conditional | string | Refer to attachment for patching details. | Additional device details to facilitate cross connect. This is mandatory when equipment patching is required. This is free text input. Limit: 1 to 4000 characters. | |
| port | Conditional | number | 10 | Device port number. This is mandatory when equipment patching is required. | |
| zSide | Yes | object | Z-side details for the cross connect. Each Z-side details object comprises of the following parameters where applicable: providerName, ibx, connectorType, circuitId, patchPanel, loaAttachmentId, notificationEmail. Z-Side can be either LOA customer (ZSideWithLOA) or customer with patch panel (zSideWithPatchPanel):
| ||
| providerName | Conditional | string | Acme Corporation | Z-side account name. This is mandatory when the Z-side is a LOA customer. | |
| ibx | Conditional | string | PE2 | Z-side IBX location code. This is mandatory when the Z-side is a LOA customer. | |
| connectorType | Conditional | string | LC | Click here for applicable values. | Z-side connector type. This is mandatory when the Z-side is a provider with patch panel. |
| circuitId | No | string | 1-12312312 | Z-side circuit ID cable reference number for verification purposes. Default: '-' | |
| patchPanel | Conditional | object | Z-side patch panel details. This is mandatory when the Z-side is a provider with patch panel. This object comprises the following parameters where applicable: id, portA, portB. | ||
| id | Conditional | string | PP:0104:1190123 | Z-side patch panel ID. | |
| portA | No | number | 1 | Port A of the patch panel to use. For more information about ports management, see Patch Panel: Ports Management in the Appendix. | |
| portB | No | number | 2 | Port B of the patch panel to use. For more information about ports management, see Patch Panel: Ports Management in the Appendix. | |
| loaAttachmentId | No | string | fcb2k8763-2947-456e-8d68-f280753d60ba | Attachment ID for LOA. This is mandatory when Z-Side is a LOA customer. The attachment, not exceeding 10MB, can be provided in the following formats: bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.See POST Attachments File under the API Reference section for more information. | |
| notificationEmail | Conditional | string | johndoe@acme.com | Z-side customer email address that will receive notification of cross connect completion. Email addresses must follow a valid email format. This is mandatory when cross connect completion refers to a patch panel of fast provisioning type, and it only applies to standard cross connect order.See GET PatchPanels under the API Reference section for more information on fast provisioning type. | |
| diverseConnections | No | object | Diverse connections details for the cross connect. Each diverse connections details object comprises the following parameters where applicable: type, serialNumber, aSide, zSide. Diverse connections can be either existing redundant or new redundant connection:
| ||
| type | Yes | string | NEW | Diverse connections can be categorized as existing or new. Type - Description | |
| serialNumber | Conditional | string | 20783335 | The serial number of Cross Connect when Diversified connection is required from a previously provisioned connection. This is mandatory when this is existing connection. | |
| aSide | Conditional | object | A-side details of diverse connections for the cross connect. Each A-side details object comprises the following parameters where applicable: patchPanel, connectorType, mediaConverterRequired, ifcCircuitCount, patchEquipment. This is mandatory when a new redundant connection is required. | ||
| patchPanel | Conditional | object | A-side patch panel details. This object comprises the following parameters where applicable: id, portA, portB. This is mandatory when a new redundant connection is required. | ||
| id | Yes | string | PP:0000:1126899 | A-side patch panel ID. | |
| portA | No | number | 12 | Port A of the patch panel to use. For more information about ports management, see Patch Panel: Ports Management in the Appendix. | |
| portB | No | number | 13 | Port B of the patch panel to use. For more information about ports management, see Patch Panel: Ports Management in the Appendix. | |
| connectorType | Conditional | string | ST | Click here for applicable values. | A-side connector type. This is mandatory when a new redundant connection is required. |
| mediaConverterRequired | No | boolean | false | true, false | Requirement for media converter. If 'true', media converter is required. If 'false', otherwise. Default value: falseMedia converters are not applicable to single mode fiber connections. You should exclude this if your connection service is 'Single-Mode Fiber'. Cross connect installations that require a media converter due to distance will be held unless 'true' is selected. |
| ifcCircuitCount | No | integer | 2 | Use this field to request an intra-facility cable IFC with this order. Note that there might be a delay in the fulfilment of Cross Connect as it is pending intra-facility cabling. Limit: 1 to 48 | |
| patchEquipment | No | object | Device information that Equinix requires to install the cross connect from demarcation panel to customer equipment, if you need to have your equipment patched. This object comprises the following parameters where applicable: cabinetId, connectorType, details, port. Smart Hands fees will apply for providing this extension. | ||
| cabinetId | Conditional | string | SG1:01:00EQ00:0001 | ID of cabinet where customer equipment for patching is located. This must belong to the specific A-side cage used in this cross connect. This is mandatory when equipment patching is required. | |
| connectorType | Conditional | string | ST | Click here for applicable values. | Device connector type to facilitate cross connect. This is mandatory when equipment patching is required. |
| details | Conditional | string | Refer to attachment for patching details. | Additional device details to facilitate cross connect. This is mandatory when equipment patching is required. This is free text input. Limit: 1 to 4000 characters. | |
| port | Conditional | number | 10 | Device port number. This is mandatory when equipment patching is required. | |
| zSide | No | object | Z-side details of diverse connections for the cross connect. Each Z-side details object comprises of the following parameters where applicable: patchPanel, connectorType, circuitId. This is mandatory when a new redundant connection is required. | ||
| patchPanel | Yes | object | Z-side patch panel details. This object comprises the following parameters where applicable: id, portA, portB. | ||
| id | Yes | string | PP:0104:1190123 | Z-side patch panel ID. | |
| portA | No | number | 1 | Port A of the patch panel to use. For more information about ports management, see Patch Panel: Ports Management in the Appendix. | |
| portB | No | number | 2 | Port B of the patch panel to use. For more information about ports management, see Patch Panel: Ports Management in the Appendix. | |
| connectorType | No | string | SC | Click here for applicable values. | Z-side connector type. |
| circuitId | No | string | 1293012000 | Z-side circuit ID cable reference number for verification purposes. Default: '-' | |
| verifyLink | No | boolean | true | true, false | Requirement for a cross connect Light Link verification. Customer may request for a Light Link reading, and transmit and receive verifications to be carried out after the cross connect is completed . In order to verify correct transmit and receive alignment, ensure customer's Z-Side connect partner has their end fully extended to their equipment and their port is enabled. If 'true', Light Link verification is required. If 'false', otherwise. Default value: falseThis will incur a fixed fee based on your contract pricing. |
| circuitDeliveryDate | No | string | 2020-10-09T10:00:22.395Z | Date when the Carrier commits to enable the circuit. Your order will be placed on hold, pending the date you enter. Equinix will wait for the Carrier to deliver the service and then will complete the installation. Format: yyyy-MM-ddIf this is an expedited order, this circuit delivery date cannot surpass the date given in the body parameter 'expediteDateTime'. | |
| submarineEngineerRequired | No | boolean | true | true, false | Requirement for submarine cable station engineering support. This is only applicable for submarine cable enabled IBXs. If 'true', submarine cable station engineering support is required. If 'false', submarine cable station engineer support is not required and order will proceed with a standard onsite engineer. Default value: false |
| expediteDateTime | No | string | 2020-10-10T06:30:22.395Z | Requested completion date and time of expedited order request. Expedite date and time should not be less than IBX local time + 2 hours, and no more than IBX local time + 24 hours. Provide a date and time (UTC time zone) in the following ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssZ Smart Hands fees will apply for providing this extension. | |
| customerReferenceId | No | string | EQX_CC_20201010 | Customer's own reference ID. This information can be searched for in Order History and will appear within Reports. This is free text input. Limit: 1 to 40 characters | |
| description | No | string | Please refer to attachment for full details for this cross connects order. | Additional details the Equinix Technician may need to complete your request. . This is free text input. Limit: 0 to 4000 characters. | |
| attachments | No | array [objects] | Attachments array comprising object(s) with attachment details. Each attachment object must contain the following parameters: id, name. Up to 5 attachments, each not exceeding 5MB, can be provided in the following formats: bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd.See POST Attachments File under the API Reference section for more information. | ||
| id | Conditional | string | 85d9660a-f877-405a-b38e-8e61a4f77f44 | Attachment id. This is mandatory when an attachment is included. You will obtain this value after attaching your file using the POST Attachments File API. Limit: 36 characters. | |
| name | Conditional | string | OrderInstructions.docx | Name of the attachment. This is mandatory when an attachment is included. You will obtain this value after using the POST Attachments File API, but you can change the name for your own reference when including this attachment in any order request. This is free text input. Limit: 5 to 100 characters. | |
| purchaseOrder | No | object | Purchase order information you want to associate with this order. This object comprises the following parameters where applicable: type, number, amount, startDate, endDate, attachmentId. | ||
| type | Conditional | string | NEW | EXEMPTED, EXISTING, NEW | Purchase order type can be categorized as exempted, existing, or new. This is mandatory when including purchase order information. Type - Description |
| number | Conditional | string | EQXPO_Ref9654284 | Purchase order number to associate with this order. This is mandatory when purchase order type is existing or new. For existing purchase orders, it the blanket purchase order number submitted throws an error, select 'EXEMPTED' for purchase order type instead.See GET PurchaseOrders under the API Reference section to retrieve your applicable blanket purchase order number. | |
| amount | No | number | 10000 | Total value amount of the new purchase order. This is only applicable when purchase order type is new. | |
| startDate | No | string | 2020-10-01 | Starting date of the new purchase order. This is only applicable when purchase order type is new. Format: yyyy-MM-dd | |
| endDate | No | string | 2021-09-30 | End date of the new purchase order. This is only applicable when purchase order type is new. Format: yyyy-MM-dd | |
| attachmentId | No | string | 56d10de6-f2c0-4edd-ba29-b70736aa2093 | Attachment ID. You can attach a new purchase order document, or the Purchase Order Exemption Form. Use the document below as a template for your Purchase Order Exemption Form. Download Purchase Order Exemption Form Template. The attachment, not exceeding 5MB, can be provided in the following formats: bmp, jpg, jpeg, gif, png, tif, tiff, txt, doc, docx, xls, xlsx, ppt, pps, ppsx, pdf, and vsd. Limit: 36 characters.This should be included when your purchase order type is new and you would like to attach the new blanket purchase order, or your purchase order type is exempted and you are submitting a Purchase Order Exemption form. See POST Attachments File under the API Reference section for more information. | |
| contacts | No | array [objects] | Contacts array consists of the technical contact and notification contact(s) information. Equinix will be able to communicate with these contacts based on their information provided. When any of the contacts are not provided, they default to the authenticated user who submitted this order (i.e. ordering contact). Technical contact is the person who Equinix can reach out to for technical clarifications. Only one technical contact can be passed.
Notification contact is the person who will be notified of status updates. At least one notification contact must be provided.
When providing the contact information for:
| ||
| type | Conditional | string | NOTIFICATION | NOTIFICATION, TECHNICAL | Defines the contact type. This is mandatory for the registered and non-registered contacts. Type - DescriptionTECHNICAL - Technical contact (applies to both registered and non-registered contacts). NOTIFICATION - Notification contact (applies to registered contact only). |
| registeredUsers | Conditional | array [strings] | john_doe, john_doe1 | Equinix Customer Portal username of the registered user. This is mandatory for a registered contact. 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. Refer to GET Users for more information. Limit for technical contact: 1 string. Limit for notification contact(s): 1 to 10 strings. | |
| firstName | Conditional | string | Jane | First name of the non-registered Technical contact. This is mandatory for a non-registered Technical contact. This is free text input. | |
| lastName | Conditional | string | Doe | Last name of the non-registered Technical contact. This is mandatory for a non-registered Technical contact. This is free text input. | |
| availability | Conditional | string | WORK_HOURS | WORK_HOURS, ANYTIME | Defines the technical contact's availability to be contacted. Availability - Description |
| timezone | Conditional | string | America/New_York | Click here for applicable values. | Defines the time zone of the technical contact's work hours. This is mandatory when the non-registered technical contact selects their work hours as their availability. For a registered technical contact, the time zone provided here will override the time zone in the user profile only for this order request, and does not replace the time zone in their user profile. For example, selecting 'America/Detroit' specifies the technical contact's work hours. |
| details | Conditional | array [objects] | Array of contact details for the non-registered technical contact consisting of the type of contact detail and its value. It is mandatory to provide two types of contacts:
| ||
| type | Conditional | string | EMAIL, MOBILE, PHONE | Defines the contact detail type. Type - DescriptionEMAIL - Email address. MOBILE - Mobile phone number. This is the secondary contact number. PHONE - Phone number. This is the primary contact number. | |
| value | Conditional | string | janedoe@acme.com | Value of the contact detail type. Phone and mobile numbers must be prefixed by '+' country code. |
| HTTP Response Header Name | Description |
| Location | Location of the newly created order. Example: /orders/{orderId} 'orderId' is the order identifier. This is important if you want to update, add notes to, retrieve and reply negotiations for, or cancel the order. It is also known as the order number in the Equinix Customer Portal. |
If you would like to update this order, see CrossConnects (V2) in the API Reference Section for more information.
If you would like to add notes to this order, retrieve and reply negotiations for this order, or cancel this order, see Orders (V2 Beta) in the API Reference Section for more information.
If you get “Insufficient permissions” error, contact your Master Administrator.