Skip to main content

Ordering a 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

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.

Ordering a New Diverse Connection

To order a new diverse connection for 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 and connector type, 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.

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

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).

Your order is successfully created when an HTTP code of 201 is returned and the response header containing the location is returned. There is no response body.

If you would like to update this order, use the [Update a cross connects order](/api-catalog/crossconnectsv2/#tag/Cross-Connects/operation/Update a Cross Connect Order) endpoint.

Ordering an Existing Diverse Connection

To order a diverse connection for an existing 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 serial number of the cross connect in the body of the request. The serial numbers of the The a-side and the z-side are 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 <token>"
-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 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).

Your order is successfully created when an HTTP code of 201 is returned and the response header containing the location is returned. There is no response body.

If you would like to update this order, use the [Update a cross connects order](/api-catalog/crossconnectsv2/#tag/Cross-Connects/operation/Update a Cross Connect Order) endpoint.