Skip to main content

Create Cross Connect Order

A cross connect is a point-to-point cable link between two customers in the same or different Equinix IBX data center. Cross connects can only be ordered by an Customer Portal user with Cross Connect & Intra-Facility Cables ordering permissions.

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.

Single or multiple quantities of cross connects may be ordered in a single request. 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.

Prerequisites​

  1. Authenticate - Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication. Refer to API Authentication for instructions on how to call the OAuth API to validate and authenticate your credentials.

A-side Information​

  1. Use the [GET Locations](/api-catalog/lookupv2/#tag/Lookup/operation/Get Locations by permission code) endpoint the location information for the starting point of your cross connect (a-side). Determine the exact IBX, cage ID, and cabinet ID. Ensure all your desired cross connects belong to the same IBX and cage.

    If you would like to patch your equipment for this cross connect, the cabinet ID will be passed in your request for the following a-side parameter: cabinetId.

    You may skip this step if you already know the location information for your a-side.

  2. Use the [GET Connection Services](/api-catalog/lookupv2/#tag/Lookup/operation/Retrieve list of connection services) to 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 for the following a-side parameters: connectionService, mediaType, connectorType, protocolType.

    You may skip this step if you already know the connection services information for your a-side.

  3. Use the [GET PatchPanels](/api-catalog/lookupv2/#tag/Lookup/operation/Retrieve all patch panels) to determine the preferred patch panel ID for your a-side. This value will be passed in your request body for the following a-side parameter (part of patchPanel object): id.

    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}](/api-catalog/lookupv2/#tag/Lookup/operation/Retrieve patch panel details) under the API Reference section.

    You may skip this step if you already know the patch panel information.

Z-side Information​

  1. Use the [GET Providers](/api-catalog/lookupv2/#tag/Lookup/operation/Retrieve list of providers) endpoint to retrieve a list of your available z-side service providers and determine their account number.

  2. Use the [GET Locations](/api-catalog/lookupv2/#tag/Lookup/operation/Get Locations by permission code) endpoint the location information for the destination of your cross connect (z-side). Determine the exact IBX, cage ID, and cabinet ID. Ensure all your desired cross connects belong to the same IBX and cage.

  3. Use the [GET Connection Services](/api-catalog/lookupv2/#tag/Lookup/operation/Retrieve list of connection services) to 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 be passed in the request body for the following z-side parameter: connectorType.

  4. Use the [GET PatchPanels](/api-catalog/lookupv2/#tag/Lookup/operation/Retrieve all patch panels) to determine the preferred patch panel ID for your a-side. This value will be passed in your request body for the following a-side parameter (part of patchPanel object): id.

  5. Refer to your service provider for their Circuit ID cable reference number. This value will be passed in the request body for the z-side parameter circuitId.

    You may skip this step if you already know the Circuit ID.

Ordering Standard Cross Connects without an LOA​

To order a standard Cross Connect, send a POST request to the [/colocations/v2/orders/crossConnects](/api-catalog/crossconnectsv2/#tag/Cross-Connects/operation/Order cross connects) endpoint.

Specify the a-side patch panel ID, full connection services details, and the Z-side connector type, circuit ID, and patch panel ID in the body of the request.

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 <token>"  
-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"  
        }  
      }  
    }  
  ]  
}'

The parameters included in the request body are specific to this example. For a full list of parameters and their descriptions, see the [API Reference](/api-catalog/crossconnectsv2/#tag/Cross-Connects/operation/Order cross connects).

Ordering Standard Cross Connects with an LOA​

To order a standard Cross Connect, send a POST request to the [/colocations/v2/orders/crossConnects](/api-catalog/crossconnectsv2/#tag/Cross-Connects/operation/Order cross connects) endpoint.

Specify the a-side patch panel ID, full connection services details, and the Z-side connector type, circuit ID, patch panel ID, and LOA attachmet ID in the body of the request.

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, use the POST Attachments File endpoint .

Sample cURL Request:

curl -X  
POST "https://api.equinix.com/colocations/v2/orders/crossConnects"  
-H "content-type: application/json"  
-H "authorization: Bearer <token>"  
-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"  
      }  
    }  
  ]  
}'

The parameters included in the request body are specific to this example. For a full list of parameters and their descriptions, see the [API Reference](/api-catalog/crossconnectsv2/#tag/Cross-Connects/operation/Order cross connects).

Ordering Standard Cross Connects Full Example​

To order a standard Cross Connect, send a POST request to the [/colocations/v2/orders/crossConnects](/api-catalog/crossconnectsv2/#tag/Cross-Connects/operation/Order cross connects) endpoint.

This example is 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.

Before creating an order with an attachment, use the POST Attachments File endpoint .

Sample cURL Request:

curl -X  
POST "https://api.equinix.com/colocations/v2/orders/crossConnects"  
-H "content-type: application/json"  
-H "authorization: Bearer <token>"  
-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"  
        }  
      ]  
    }  
  ]  
}'

For a full list of parameters and their descriptions, see the [API Reference](/api-catalog/crossconnectsv2/#tag/Cross-Connects/operation/Order cross connects).