Skip to main content
Index

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

CrossConnects.v2.beta.2

 

Step 1: Authenticate

Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication.

 

Refer to Generating a Client ID and Client Secret key under Getting Started 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, account number, and cabinet ID for your A-side criteria. Ensure all your desired cross connects belong to the same A-side IBX, cage, and account number.

 

You will need these values in the subsequent steps to get your required A-side and Z-side details. 

 

If your cross connect is from a shared cabinet, you will also need to pass the A-side cage account number in the subsequent steps. This value would also need to be passed in your request body in Step 3 for the following A-side parameter: accountNumber.

 

If you would like to patch your equipment for this cross connect, the cabinet ID will be passed in your request body in Step 3 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 all the available patch panels for your A-side criteria 

Retrieve a list of your available patch panels.

 

Determine the preferred patch panel ID for your A-side criteria. 

 

You will need this value in the subsequent step to retrieve your connection services details.

 

This value will also be passed in your request body in Step 3 for the following A-side parameter (part of patchPanel object): id.

 

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.

 

2c) Get patch panel ports and connection services details for your A-side criteria 

Retrieve all the ports and connection services information for your preferred patch panel. 

 

Determine the patch panel ports and connection services information for your A-side criteria.

 

These values will be passed in the request body in Step 3 for the following A-side parameters: connectionService, mediaType, protocolType, connectorType, portA, portB (portA and portB are a part of patchPanel object).

 

Refer to GET PatchPanels {patchPanelId} under the API Reference section for instructions on how to get the patch panel port and connection services information. You may skip this step if you already know these details for your A-side.  

 

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.

 

You will need this value to in the subsequent steps to get your required Z-side details. 

 

This value will also be passed in the request body in Step 3 for the following Z-side parameters: accountNumber.

 

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 3 for the following Z-side parameters: connectionService, 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 3 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: 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 {accountNumber, connectionService, mediaType, protocolType, connectorType, mediaConverterRequired, patchPanel {id, portA, portB}, patchEquipment {cabinetId, connectorType, details, port}}, zSide {accountNumber, providerName, ibx, connectionService, connectorType, circuitId, patchPanel {id, portA, portB}, loaAttachmentId, notificationEmail}, 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. This request is initiated by the A-side customer 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 fulfil 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 wish to order do not fulfill this criteria, you need to submit separate order requests. 

 

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 Started section.

 

The following screenshots show sample curl requests based on the following scenarios:

 

(A) An order for cross connects from an account with a private cabinet to an existing service provider without LOA attachment (minimum required information)

 

(B) An order for cross connects from an account with a shared cabinet to an existing service provider without LOA attachments (minimum required information)

 

(C) An order for cross connects from an account with a private cabinet to an existing service provider with LOA attachment (minimum required information)

 

(D) An order for cross connects from an account with a shared cabinet to an existing service provider with LOA attachments (minimum required information)

 

(E) An order for cross connects from an account with a private cabinet to a new service provider with LOA attachment (minimum required information)

 

(F) An expedited order for cross connects from an account with a shared cabinet 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 with a private cabinet to an existing service provider without LOA attachment (minimum required information)

A cross connects order from a private cabinet to an existing service provider without a Letter of Agreement (LOA) attached, minimally requires the A-side patch panel ID and full connection services details, and the Z-side, connection service, 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": {

        "connectionService": "MULTI_MODE_FIBER",
        "connectorType": "LC",
        "circuitId": "1-12312312",
        "patchPanel": {
          "id": "PP:0104:1190123"
        }
      }
    }
  ]
}
'

 

(B) An order for cross connects from an account with a shared cabinet to an existing service provider without LOA attachments (minimum required information)

A cross connects order from a shared cabinet to an existing service provider without Letter of Agreement (LOA) attached, minimally requires the A-side account number, patch panel ID, and full connection services details, and the Z-side connection service, 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": {
        "accountNumber": "901011",
        "connectionService": "SINGLE_MODE_FIBER",
        "mediaType": "SINGLE_MODE_FIBER",
        "protocolType": "10 GIG ETHERNET",
        "connectorType": "FC",
        "patchPanel": {
          "id": "CP:0104:1199890"
        }
      },
      "zSide": {
        "connectionService": "MULTI_MODE_FIBER",
        "connectorType": "LC",
        "circuitId": "1-12312312",
        "patchPanel": {
          "id": "PP:0104:1190123"
        }
      }
    }

  ]
}
'

 

(C) An order for cross connects from an account with a private cabinet to an existing service provider with LOA attachment (minimum required information) 

A cross connects order from a private cabinet to an existing service provider with LOA attached, minimally requires the A-side patch panel ID and full connection services details, and the Z-side connection service, 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 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": {
        "connectionService": "MULTI_MODE_FIBER",
        "patchPanel": {
          "id": "PP:0104:1190123"
        },
        "loaAttachmentId": "fcb2k8763-2947-456e-8d68-f280753d60ba"
      }
    }
  ]
}
'

 

(D) An order for cross connects from an account with a shared cabinet to an existing service provider with LOA attachments (minimum required information)

A cross connects order from a shared cabinet to an existing service provider with LOA attached, minimally requires the A-side account number, patch panel ID and full connection services details, and the Z-side connection service, 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 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": {

        "accountNumber": "901011",
        "connectionService": "SINGLE_MODE_FIBER",
        "mediaType": "SINGLE_MODE_FIBER",
        "protocolType": "10_GIG_ETHERNET",
        "connectorType": "FC",
        "patchPanel": {
          "id": "PP:0501:1093542"
        }
      },
      "zSide": {
        "connectionService": "MULTI_MODE_FIBER",
        "patchPanel": {
          "id": "PP:0104:1190123"
        },
        "loaAttachmentId": "fcb2k8763-2947-456e-8d68-f280753d60ba"
      }
    }
  ]
}
'

 

(E) An order for cross connects from an account with a private cabinet to a new service provider with LOA attachment (minimum required information)

A cross connects order from a shared cabinet to a new service provider with LOA attached, minimally requires the A-side account number, patch panel ID and full connection services details, and the Z-side provider name, IBX, connection service, 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 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": "New Telco. Corp.",
        "ibx": "AM1",
        "connectionService": "SINGLE_MODE_FIBER",
        "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; and 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 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 with a shared cabinet to a new service provider with LOA attachment, along with other attachments, information, and requests

A cross connects order from a shared cabinet to a new service provider with LOA attached, minimally requires the A-side account number, patch panel ID and full connection services details, and the Z-side provider name, IBX, connection service, 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 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": {
        "accountNumber": "901011",
        "connectionService": "SINGLE_MODE_FIBER",
        "mediaType": "SINGLE_MODE_FIBER",
        "protocolType": "10_GIG_ETHERNET",
        "connectorType": "FC",

        "mediaConverterRequired": false,
        "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": "New Telco. Corp.",
        "ibx": "PE2",
        "connectionService": "MULTI_MODE_FIBER",
        "connectorType": "LC",
        "circuitId": "1-12312312",
        "patchPanel": {
          "id": "PP:0104:1190123",
          "portA": "1",
          "portB": "2"
        },
        "loaAttachmentId": "fcb2k8763-2947-456e-8d68-f280753d60ba",
        "notificationEmail": "johndoe@telco.corp.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": [
        "janesmith123",
        "jimsnow1"
      ]
    },
    {
      "type": "TECHNICAL",
      "firstName": "Carmen",
      "lastName": "Santiago",
      "availability": "WORK_HOURS",
      "timezone": "America/New_York",
      "details": [
        {

          "type": "EMAIL",
          "value": "csantiago@acme.com"
        },
        {

          "type": "PHONE",
          "value": "+1-987654321"
        },
        {

          "type": "MOBILE",
          "value": "+1-912345678"
        }
      ]
    }
  ]
}'

 

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

  • 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
aSide Yes object     A-side details for the cross connect. Each A-side details object comprises the following parameters where applicable: accountNumber, connectionService, mediaType, protocolType, connectorType, mediaConverterRequired, patchPanel, patchEquipment.
accountNumber Conditional string 901011   A-side account number. This is mandatory when the A-side cabinet is a shared cabinet. 
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.
mediaConverterRequired No boolean false

true,

false

Requirement for media converter. 

 

If 'true', media converter is required. If 'false', otherwise.

 

Default value: false

 

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

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.


If a port number is not specified, the next available port will be used. 

portB No number 13  

Port B of the patch panel to use.

 

If a port number is not specified, the next available port will be used. 

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 the following parameters where applicable: accountNumber, providerName, ibx, connectionService, connectorType, circuitId, patchPanel, loaAttachmentId, notificationEmail.
accountNumber No string 100006   Z-side account number. 
providerName Conditional string New Telco. Corp.   Z-side account name. This is mandatory when the Z-side is a new provider.
ibx Conditional string PE2   Z-side IBX location code. This is mandatory when the Z-side is a new provider.
connectionService Yes string MULTI_MODE_FIBER Click here for applicable values. Z-side connection service.
connectorType Conditional string LC Z-side connector type. This is mandatory when the Z-side is an existing provider.
circuitId Conditional string 1-12312312   Z-side circuit ID cable reference number for verification purposes. This is mandatory when the Z-side is an existing provider and LOA is not attached.
patchPanel Conditional object    

Z-side patch panel details. This is mandatory when the Z-side is an existing provider.

 

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.


If a port number is not specified, the next available port will be used. 

portB No number 2  

Port B of the patch panel to use.


If a port number is not specified, the next available port will be used. 

loaAttachmentId No string fcb2k8763-2947-456e-8d68-f280753d60ba  

Attachment ID for LOA.

 

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 for more information.

notificationEmail No string johndoe@telco.corp.com  

Z-side customer email address that will receive notification of cross connect completion. 

Email addresses must follow a valid email format.

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, please 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: false

 

This 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-dd

 

If 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 timezone) 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 wish 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

EXEMPTED - You are exempted from: a) including a purchase order in your request, or b) you are applying for exemption to include a purchase order in your request. If b), see body parameter 'attachmentId'.

EXISTING - You would like to use an existing blanket purchase order for this order. Body parameter 'number' is mandatory with this.

NEW -  You would like to use a new blanket purchase order which has not yet been applied for any order. Body parameter 'number' is mandatory with this. You can also include the following parameters: amount, startDate, endDate, attachmentId.

 

Default: EXEMPTED 

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.

amount No number 10000  

Total value amount of the new purchase order. This is only applicable when purchase order type is new. 

 

Format: yyyy-MM-dd

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

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 ticket (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. If they are a registered Equinix Customer Portal user, only their username needs to be passed. All their contact details will be referred from their user profile in the Equinix Customer Portal. Their work hours timezone will also be referred from the user profile, unless otherwise included in this request. If they are a non-registered contact, their full name and contact details must be provided. To include more information such as the technical contact's availability or timezone, see parameter 'details'.

 

Notification contact is the person who will be notified of status updates. At least one notification contact must be provided. They must be a registered Equinix Customer Portal user. Only their username needs to be passed.

 

If providing the contact information for a registered contact object, the following body parameters are mandatory: registeredUsers, type. All other attributes passed in a registered contact object will be ignored.

 

If providing the contact information for a non-registered contact object, the following body parameters are mandatory: name, type, details. 

 

For more information on technical contact's work hours timezone, see description of body parameter, 'timezone'.

type Conditional string NOTIFICATION

NOTIFICATION,

TECHNICAL 

Defines the contact type. This is mandatory for the registered and non-registered contact. 

 

Type - Description

TECHNICAL - Technical contact. 

NOTIFICATION - Notification contact. 

registeredUsers Conditional

array

[strings]

janesmith123,

jimsnow1

 

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. 

 

Limit for technical contact: 1 string.

 

Limit for notification contact(s): 1 to 10 strings. 

firstName Conditional string Carmen

 

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 Santiago  

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

ANYTIME - Technical contact is available 24/7.

WORK_HOURS - Technical contact is only available during work hours in their timezone. For a registered technical contact, their work hours is defaulted to the timezone in their user profile. If they would like to provide a different timezone, they should provide it in the body parameter 'timezone'. For a non-registered technical contact, if they select their work hours, the parameter 'timezone' is mandatory.

 

Default value: ANYTIME

timezone Conditional string America/New_York Click here for applicable values.

Defines the timezone 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 timezone provided here will override the timezone in the user profile only for this ticket request, and does not replace the timezone 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 a phone number and an email address. Only one of each can be provided. Providing a mobile number is optional. 

 

Limit: 2 to 3 objects. 

type Conditional string EMAIL EMAIL,  
MOBILE, 
PHONE

Defines the contact detail type.

 

Type - Description
EMAIL - Email address.
MOBILE - Mobile phone number. This is the secondary contact number. 
PHONE - Phone number. This is the primary contact number.

value Conditional string csantiago@acme.com  

Value of the contact detail type. 

 

Phone numbers must be prefixed by '+' country code. For example, +1-987-654-3210 or +1 987 654 3210.

Email addresses must follow a valid email format.

 

Order is successfully created when an HTTP code of 201 is returned and the following response header is returned. There is no response body.

 

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

Order multiple cross connects (V1)

Multi CC v2

Step 1: Authenticate

Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication.

 

Refer to Generating a Client ID and Client Secret key under Getting Started 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: Check Cross Connect Types

To get cross connect types, the user must have Cross Connect & Intra-Facility Cables ordering permission. If you are unaware of your user permissions, contact your Master Administrator. 

 

Get cross connect types

Retrieve the cross connect types that the user has permission to order.
 

Determine if the user can order the preferred cross connect type.

 

Refer to GET Crossconnect Types under the API Reference section for instructions on how to retrieve available cross connect types. You may skip this step if you already know the user has permission to order this cross connect type.

Step 3: 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. 

 

3a) Get cross connect location information for the starting point of the cross connect (A-side)

Retrieve the IBX location information for the preferred cross connect type.

 

Determine the exact IBX location code, cage ID, cage account number, and cabinet ID for your A-side criteria.

 

These values will be needed in the subsequent steps to get the required A-side and Z-side details.

 

These values will also be passed in the request body in Step 4 for the following A-side parameters (in the ibxLocation object): ibx, cage, accountNumber, cabinets.

 

Refer to GET Crossconnect Locations under the API Reference section for instructions on how to get all the cross connect location information. You may skip this step if you already know the location information for your A-side.  

 

3b) Get connection services information for your A-side criteria 

Retrieve all the connection services information for the preferred cross connect type.

 

Determine which connection service, media type, connector type, and protocol type to use for your A-side criteria. 

 

This media type value will be needed in Step 3c to get the required patch panel details.

 

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 Crossconnect Connection Services under the API Reference section for instructions on how to retrieve available connection services. You may skip this step if you already know the connection services information for your A-side.

 

3c) Get patch panel information for your A-side criteria 

Retrieve all the patch panel information for the preferred cross connect type. 

 

Determine the patch panel number and the patch panel ports to use for the selected media type.

 

These values will also be passed in the request body in Step 4 for the following A-side parameters (in the patchpanel object): name, portA, portB.

 

Refer to GET Crossconnect Patchpanel under the API Reference section for instructions on how to get all the patch panel information. You may skip this step if you already know the patch panel information for your A-side.  

 

3d) Get service providers information (end point of the cross connect or Z-side)

Retrieve all the service providers information for the preferred cross connect type. 

 

Determine the service provider's account name and account number.

 

The provider's account number will be needed in the subsequent steps to get the required Z-side details.

 

These values will also be passed in the request body in Step 4 for the following Z-side parameters: customer, customerAccount.

 

Refer to GET Crossconnect 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.  

 

3e) Get your Z-side criteria details by repeating steps 3a to 3c 

Retrieve all the same details from steps 3a to 3c for the Z-side criteria.

 

These values will be passed in the request body in Step 4 for the following Z-side parameters: ibx, cage, cabinets, connectionService, connectorType, patchpanel.

 

You may skip this step if you already know your Z-side criteria details.

 

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

 

3g) For multiple quantities of cross connects, repeat steps 3a to 3f to get the necessary A-side and Z-side information.

Retrieve the necessary A-side and Z-side criteria details for your multiple 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 4: Order Multiple Cross Connects

POST /crossconnects/

 Method  POST
 URL or End Point  /v1/orders/crossconnects/
 Headers  Authorization, Content-Type
 Query Parameters  action
 Body

 customerReferenceNumber, purchaseOrder {purchaseOrderType, attachment {id, name}}, contacts [{contactType, userName}, {contactType, name, email, workPhoneCountryCode, workPhone, workPhonePrefToCall, mobilePhoneCountryCode, mobilePhone, mobilePhonePrefToCall, mobilePhoneTimeZone}]}, schedule {requestedCompletionDate, scheduleType}, additionalDetails, attachments [{id, name}], serviceDetails [{aside {ibxLocation {ibx, cages [{cage, cabinets[...], accountNumber}]}, connectionService, mediaType, proceedIfMediaCoverterIsRequired, protocolType, connectorType, focDate, patchpanel {name, portA, portB}}, zside {customer, customerAccount, ibxLocation {ibx, cages [{cage, cabinets[...]}]}, connectionService, connectorType, patchpanel {name, portA, portB}, circuitId, loa {attachments [{id, name}]}, notifyZsideUponCompletion, zSideContactEmail}, patchEquipment, device {cabinet, connectorType, details, port}, lightLinkVerificationRequired, needSupportFromASubmarineCableStationEngineer}]

 

This method creates multiple quantities of cross connects in one order request for an authenticated user with Cross Connect & Intra-Facility Cables ordering permission.

 

These multi-quantity cross connects can only be submitted in one order request if they fulfil 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 25

 

If the cross connects you wish to order do not fulfill this criteria, you need to submit separate order requests. 

 

Only the standard cross connect type is currently supported for multi-quantity cross connect orders.

 

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 Started section.

 

The following screenshots show sample curl requests and JSON response for this API.

 

Multiple standard cross connects order without additional information or attachment 

 

curl -X

POST 

"https://api.equinix.com/v1/orders/crossconnects?action=SUBMIT"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

-d '{
   "contacts": [
    {
      "contactType": "ORDERING",
      "userName": "johndoe1"
    },
    {
      "contactType": "TECHNICAL",
      "userName": "johndoe1",
      "workPhonePrefToCall": "ANYTIME"
    },
    {
      "contactType": "NOTIFICATION",
      "userName": "johndoe1"
    }
  ],
  "schedule": {
    "requestedCompletionDate": "2019-07-25T01:59:58.201Z",
    "scheduleType": "EXPEDITED"
  },
  "serviceDetails": [
    {
      "aside": {
        "ibxLocation": {
          "ibx": "DA1",
          "cages": [
            {
              "cage": "DA1:R1:V0350-1-254",
              "cabinets": [
                "DA1:R1:V0350-1-254:V001002"
              ],
              "accountNumber": "987"
            }
          ]
        },
        "connectionService": "COAX",
        "mediaType": "COAX",
        "protocolType": "ANTENNA",
        "connectorType": "BNC",
        "patchpanel": {
          "name": "PP:0102:2345",
          "portA": "Next Available",
          "portB": "Next Available"
        }
      },
      "zside": {
        "customerAccount": "3988",
        "ibxLocation": {
          "ibx": "DA3",
          "cages": [
            {
              "cage": "DA3:001:0100300",
              "cabinets": [
                "DA3:001:0100300:00206"
              ]
            }
          ]
        },
        "connectionService": "COAX",
        "connectorType": "BNC",
        "patchpanel": {
          "name": "CP:0206:102232",
          "portA": "5",
          "portB": "Next Available"
        },
        "circuitId": "73/HCGS/123456/000/CC",
        "loa": {}
      }
    },
    {
      "aside": {
        "ibxLocation": {
          "ibx": "DA1",
          "cages": [
            {
              "cage": "DA1:R1:V0350-1-254",
              "cabinets": [
                "DA1:R1:V0350-1-254:V001010"
              ],
              "accountNumber": "987"
            }
          ]
        },
        "connectionService": "COAX",
        "mediaType": "COAX",
        "protocolType": "ANTENNA",
        "connectorType": "BNC",
        "patchpanel": {
          "name": "PP:0102:2345",
          "portA": "Next Available",
          "portB": "Next Available"
        }
      },
      "zside": {
        "customerAccount": "3988",
        "ibxLocation": {
          "ibx": "DA3",
          "cages": [
            {
              "cage": "DA3:001:0100300",
              "cabinets": [
                "DA3:001:0100300:00212"
              ]
            }
          ]
        },
        "connectionService": "COAX",
        "connectorType": "BNC",
        "patchpanel": {
          "name": "CP:0206:102232",
          "portA": "6",
          "portB": "Next Available"
        },
        "circuitId": "73/HCGS/123456/000/CC",
        "loa": {}
      }
    }
  ]
}'

 


Multiple standard cross connects order with additional information and attachments

 

Before creating an order with attachment, call the POST Attachments File under the API Reference section.

 

curl -X

POST 

"https://api.equinix.com/v1/orders/crossconnect/standard?action=SUBMIT"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

-d '{
   "customerReferenceNumber": "SCC138765",
  "purchaseOrder": {
    "purchaseOrderType": "EXEMPTED",
    "attachment": {
      "id": "abc1fd2e-345f-67g4-hi89-01jk234l5m6n",
      "name": "PurchaseOrderExemptionForm123.docx"
    }
  },
  "contacts": [
    {
      "contactType": "ORDERING",
      "userName": "johndoe1"
    },
    {
      "contactType": "TECHNICAL",
      "name": "Jane Smith",
      "email": "janesmith@thiscorp.com",
      "workPhoneCountryCode": "+1",
      "workPhone": "800-322-9280",
      "workPhonePrefToCall": "MY_BUSINESS_HOURS",
      "workPhoneTimeZone": "America/Chicago",
      "mobilePhoneCountryCode": "+1",
      "mobilePhone": "555-555-1234",
      "mobilePhonePrefToCall": "ANYTIME"
    },
    {
      "contactType": "NOTIFICATION",
      "userName": "johndoe1"
    }
  ],
  "schedule": {
    "requestedCompletionDate": "2019-07-25T01:59:58.201Z",
    "scheduleType": "EXPEDITED"
  },
  "additionalDetails": "Refer to attachment.",
  "attachments": [
    {
      "id": "507f8877-4894-4ca6-ac9f-3995c59a4ce6",
      "name": "AdditionalDetailsAttachment.docx"
    }
  ],
  "serviceDetails": [
    {
      "aside": {
        "ibxLocation": {
          "ibx": "DA1",
          "cages": [
            {
              "cage": "DA1:R1:V0350-1-254",
              "cabinets": [
                "DA1:R1:V0350-1-254:V001002"
              ],
              "accountNumber": "987"
            }
          ]
        },
        "connectionService": "COAX",
        "mediaType": "COAX",
        "proceedIfMediaCoverterIsRequired": false,
        "protocolType": "ANTENNA",
        "connectorType": "BNC",
        "focDate": "2019-07-25T01:59:58.201Z",
        "patchpanel": {
          "name": "PP:0102:2345",
          "portA": "Next Available",
          "portB": "Next Available"
        }
      },
      "zside": {
        "customer": "Carigan Communications",
        "customerAccount": "3988",
        "ibxLocation": {
          "ibx": "DA3",
          "cages": [
            {
              "cage": "DA3:001:0100300",
              "cabinets": [
                "DA3:001:0100300:00206"
              ]
            }
          ]
        },
        "connectionService": "COAX",
        "connectorType": "BNC",
        "patchpanel": {
          "name": "CP:0206:102232",
          "portA": "5",
          "portB": "Next Available"
        },
        "circuitId": "73/HCGS/123456/000/CC",
        "loa": {
          "attachments": [
            {
              "id": "0549c413-acc9-4c4b-9067-e7551890b46d",
              "name": "LOA2017/36912.docx"
            }
          ]
        },
        "notifyZsideUponCompletion": true,
        "zSideContactEmail": "johndoe@corp.com"
      },
      "patchEquipment": true,
      "device": {
        "cabinet": "V0102",
        "connectorType": "BNC",
        "details": "Call the technical contact before patching.",
        "port": "any available"
      },
      "lightLinkVerificationRequired": true,
      "needSupportFromASubmarineCableStationEngineer": true
    },
    {
      "aside": {
        "ibxLocation": {
          "ibx": "DA1",
          "cages": [
            {
              "cage": "DA1:R1:V0350-1-254",
              "cabinets": [
                "DA1:R1:V0350-1-254:V001010"
              ],
              "accountNumber": "987"
            }
          ]
        },
        "connectionService": "COAX",
        "mediaType": "COAX",
        "proceedIfMediaCoverterIsRequired": false,
        "protocolType": "ANTENNA",
        "connectorType": "BNC",
        "focDate": "2019-07-25T01:59:58.201Z",
        "patchpanel": {
          "name": "PP:0102:2345",
          "portA": "Next Available",
          "portB": "Next Available"
        }
      },
      "zside": {
        "customer": "Carigan Communications",
        "customerAccount": "3988",
        "ibxLocation": {
          "ibx": "DA3",
          "cages": [
            {
              "cage": "DA3:001:0100300",
              "cabinets": [
                "DA3:001:0100300:00212"
              ]
            }
          ]
        },
        "connectionService": "COAX",
        "connectorType": "BNC",
        "patchpanel": {
          "name": "CP:0206:102232",
          "portA": "6",
          "portB": "Next Available"
        },
        "circuitId": "73/HCGS/123456/000/CC",
        "loa": {
          "attachments": [
            {
              "id": "0549c413-acc9-4c4b-9067-e7551890b46d",
              "name": "LOA2017/36912.docx"
            }
          ]
        },
        "notifyZsideUponCompletion": true,
        "zSideContactEmail": "johndoe@corp.com"
      },
      "patchEquipment": true,
      "device": {
        "cabinet": "V0102",
        "connectorType": "BNC",
        "details": "Call the technical contact before patching.",
        "port": "any available"
      },
      "lightLinkVerificationRequired": true,
      "needSupportFromASubmarineCableStationEngineer": true
    }
  ]
}'

 

The description of the query and request payload is as follows:

 

Query Parameter Name Mandatory Type Example Applicable Values Description
action Yes string

SUBMIT

SUBMIT

The action to submit the order.

 

When 'Conditional' is indicated for a Body Parameter, refer to Description for further details. 

 

Body Parameter Name Mandatory Type Example Applicable Values Description
quantityRequested No integer    

Number of cross connects ordered.
 

Default value:1

 

The quantity of cross connects requested will be counted from the number of objects passed in the serviceDetails array. 

 

If you pass this field with value more than 1, the order will fail.
 

This field will be deprecated in the future. You may ignore this.

customerFollowUpRequired No boolean    

Requirement for customer follow-up.
 

Default value: false
 

Any follow up is directly communicated to the customer. 

 

This field will be deprecated in the future. You may ignore this.

customerReferenceNumber No string SCC138765  

Customer reference information for this order. 

 

This can be a Purchase Order number or an internal code. This information can be searched for in Order History and will appear within Reports.

 

This is free text input.

 

Limit: 1 to 50 characters. 

purchaseOrder Conditional object    

Purchase order (PO) information details. This is mandatory for PO bearing accounts. 

 

The object comprises the following parameters where applicable: purchaseOrderType; number; attachment object.

 

If you do not know your account's PO bearing status, refer to GET Crossconnect Locations under the API Reference section.

purchaseOrderType Conditional string EXEMPTED

EXEMPTED,

EXISTING

Type of purchase order you want to link to this order. This is mandatory for PO bearing accounts.  

 

Purchase orders can be defined as new, existing, or exempted. However, only existing and exempted purchase order types are currently being supported.

 

If 'EXISTING', the blanket purchase order is already known to Equinix and the purchase order number must be sent. Only numbers for blanket purchase orders will be accepted. If you do not have a valid blanket purchase order number, see 'EXEMPTED'.

 

If 'EXEMPTED', there are 2 scenarios where this option applies:-

 

1. A purchase order exemption form has already been submitted and approved, and a purchase order number is not required. No additional information or attachments are required.

 

2. A purchase order exemption request is made together with this order. A Purchase Order Exemption form should be attached to facilitate the exemption request.  

number Conditional string    

Blanket purchase order number. This is mandatory if purchase order type is 'EXISTING'.

 

If the blanket purchase order number submitted throws an error, select 'EXEMPTED' for purchase order type instead.

 

This is free text input.

 

Limit: 1 to 20 characters.

attachment Conditional object    

An object containing the attachment details of the Purchase Order Exemption Form. 

 

The object comprises the following parameters: id; name.

 

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.

 

This should be included when purchase order type is 'EXEMPTED' and you are submitting a Purchase Order Exemption form.

 

Refer to POST Attachments File under the API Reference section for more information. 

id Conditional string abc1fd2e-345f-67g4-hi89-01jk234l5m6n  

ID of the attachment. This is mandatory when an attachment is included.

 

You will obtain this value after attaching your file using the Attachments API. 

name Conditional string PurchaseOrderExemptionForm123.docx  

Name of the attachment. This is mandatory when an attachment is included.

 

You will obtain this value after attaching your file using the Attachments API, but you may change the name for your own reference when including this attachment in any order request.

 

This is free text input.

 

Limit: minimum 1 character.

contacts Yes

array

[objects]

   

Contacts array consists of objects representing the Ordering, Technical, and Notification contacts.

Only one Ordering contact object, only one Technical contact object, and at least one Notification contact object must be included.

 

Ordering and Notification contacts must be registered Equinix Customer Portal users with the appropriate user status. The following parameters are mandatory to include in the objects for Ordering and Notification contacts: userName; type. 

 

If the Technical contact is a registered Equinix Customer Portal user with the appropriate user status, the following parameters are mandatory to include in the object for Technical contact: userName; type; workPhonePrefToCall.

 

If the Technical contact is not a registered portal user with the appropriate user status, the following parameters are mandatory to include in the object for Technical contact: contactType; name; email; workPhone; workPhonePrefToCall. Other parameters that may also be included are: workPhoneCountryCode; workPhoneTimeZone; mobilePhoneCountryCode; mobilePhone; mobilePhonePrefToCall.

contactType Yes string ORDERING

ORDERING,

TECHNICAL,

NOTIFICATION

 

Types of contact persons. 

 

Contact Type - Description

ORDERING - Person who created the order. Only one Ordering contact can be passed.

TECHNICAL -  Person who Equinix can reach out to for technical clarifications. Only one Technical contact can be passed.

NOTIFICATION - Person who will be notified of status updates. At least one notification contact must be provided. If notification contact is not available to pass, use ordering contact as notification contact.

userName Yes string johndoe1  

Equinix-registered username of contact person. This is mandatory for Ordering and Notification contact objects, and conditional for Technical 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. 

If Technical contact has a registered Equinix Customer Portal username with the appropriate status, this field should be included. 

 

If Technical contact does not have the required username, see body parameter 'name'. 

 

With the exception of the mandatory contact information required for the Technical contact, any other additional contact information passed together with parameter 'userName' for Ordering, Technical, and Notification contacts will be ignored.

 

For example, if 'email' and 'workPhone' information is passed with 'userName' for Notification contact, this information will be ignored.

name Conditional string Jane Smith  

Full name of contact person. This is mandatory when the Technical contact does not have the required username.

 

This is free text input. 

email Conditional string janesmith@thiscorp.com  

Email information of contact person. This is mandatory when the Technical contact does not have the required username.

 

This is free text input. 

workPhoneCountryCode No string +1  

Country code for work phone number of the contact person.

 

This is free text input. 

 

It is recommended to include the work phone country code. 

workPhone Conditional string 800-322-9280

 

Work phone number of contact person. This is mandatory when the Technical contact does not have the required username.

 

This is free text input. 

workPhonePrefToCall Yes string MY_BUSINESS_HOURS

NEVER,
ANYTIME,
MY_BUSINESS_HOURS,
IBX_BUSINESS_HOURS,
BUSINESS_HOURS

Availability of Technical contact person to take calls. This is mandatory for the Technical contact.

 

Call Preference - Description
NEVER - Does not take calls.

ANYTIME - Takes calls anytime. 

MY_BUSINESS_HOURS - Takes calls only during their business hours. This would be in their specified time zone from Mondays to Fridays, 9am to 5pm. The body parameter 'workPhoneTimeZone' is mandatory to pass when this option is selected.

IBX_BUSINESS_HOURS - Takes calls only during the business hours of the IBX. This would be in the IBX time zone from Mondays to Fridays, 9am to 5pm.

 


Deprecated values

BUSINESS_HOURS - This value will be removed in the near future.

workPhoneTimeZone Conditional string America/Chicago Click here for applicable values.

This indicates the specific timezone of the Technical contact's business hours that follows the IANA time zone database names format. This is mandatory when 'MY_BUSINESS_HOURS' is selected for 'workPhonePrefToCall'.

mobilePhoneCountryCode No string +1

 

Mobile phone number country code of contact person. 

 

This is free text input. 

mobilePhone No string 555-555-1234  

Mobile phone number of contact person.

 

This is free text input. 

mobilePhonePrefToCall No string ANYTIME

NEVER,
ANYTIME,
MY_BUSINESS_HOURS,
IBX_BUSINESS_HOURS,
BUSINESS_HOURS

Availability of Technical contact person to take calls on their mobile phone.

 

For description of applicable values, refer to description of body parameter 'workPhonePrefToCall'.

mobilePhoneTimeZone Conditional string   Click here for applicable values.

This indicates the specific timezone of the Technical contact's business hours that follows the IANA time zone database names format.

 

This should be included when 'MY_BUSINESS_HOURS' is selected for 'mobilePhonePrefToCall' and the mobile phone timezone differs from the work phone timezone. If 'mobilePhoneTimeZone' is not included, it will be assumed that both the work phone and mobile phone timezones are the same. 

schedule Yes

object

   

Scheduling information for the installation of the order.  

 

The object comprises the following parameters, where applicable: requestedCompletionDate; scheduleType.

 

This schedule will apply to the entire order and cannot be applied to individual cross connects.

requestedCompletionDate Conditional string 2019-07-25T01:59:58.201Z  

Requested completion date and time of scheduled cross connect installation. 

 

Expedited scheduling date should not be less than IBX local time + 2 hours, and no more than IBX local time + 24 hours.

 

If 'EXPEDITED' schedule type, provide a date and time (UTC timezone) in one of the following ISO 8601 formats:

 

yyyy-MM-dd'T'HH:mm:ssZ,

yyyy-MM-dd'T'HH:mm:ss.SSSZ.

 

In the case of 'STANDARD' schedule type, this parameter is not required.

scheduleType Yes string EXPEDITED

EXPEDITED,

STANDARD

Define your preferred scheduling type.

 

These are the scheduling types supported for this cross connect.

 

Schedule Types 
 

STANDARD: Request will be processed in the standard turnaround time. Most requests are completed within 24 to 72 hours pending your install base readiness. Requests will be processed in the order they were received, unless they are expedited.
- Parameter 'requestedCompletionDate' is not required. 

 

EXPEDITED: Request will be completed within the next 2 to 24 hours. Additional Smart Hands fees may apply. Schedule a time in the current local time of the IBX you selected. Equinix will contact customer for schedule negotiation if preferred scheduling cannot be met.
- Parameter 'requestedCompletionDate' is required. 

additionalDetails No string Refer to attachment.  

Additional details the Equinix Technician may need to complete your request.

 

This is free text input.

 

Limit: 1 to 4000 characters.

attachments No

array

[objects]

   

Attachments array contains objects of attachments information. Provide any other supportive photos or documents to help the technician to complete your order. 

 

Each attachment object comprises 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.

 

Refer to POST Attachments File under the API Reference section for more information. 

id Conditional string 507f8877-4894-4ca6-ac9f-3995c59a4ce6  

ID of the attachment. This is mandatory when an attachment is included.

 

You will obtain this value after attaching your file using the attachment API. 

name Conditional string AdditionalDetailsAttachment.docx  

Name of the attachment. This is mandatory when an attachment is included.

 

You will obtain this value after attaching your file using the attachment API, but you may change the name for your own reference when including this attachment in any order request. This is free text input. 

serviceDetails Yes

array

[objects] 

 

 

Service details array consists of objects of cross connects.

 

Each cross connect object comprises cross connect information for one A-side object (starting point of cross connect) and one Z-side object (end point of cross connect). 


Limit: 1 to 25 cross connects objects. 

 

If your desired cross connects do not fulfil the following criteria, you need to submit separate order requests for these cross connects.

  • 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
  Yes object     

A-side cross connect information.

 

The object comprises the following parameters where applicable: ibxLocation object; connectionService; mediaType; proceedIfMediaCoverterIsRequired; protocolType; connectorType; focDate; patchpanel object; patchEquipment; device object; lightLinkVerificationRequired. 

ibxLocation Yes object    

IBX location information that consists of the IBX location code, cages information, and cage account number.

 

The object comprises the following parameters where applicable: ibx; cages array.

 

Refer to GET Crossconnect Locations under the API Reference section for more information. 

ibx Yes string DA1  

The IBX location code.

cages Yes

array

[object]

   

Cages array contains objects of cage information.

 

Each cage object comprises the following parameters where applicable: cage; cabinets array; accountNumber.

 

Only 1 cage per order is currently being supported. Provide information for only 1 cage.

cage Yes string DA1:R1:V0350-1-254  

ID of the cage.

cabinets Yes

array

[string]

DA1:R1:V0350-1-254:V001002  

ID of the cabinet.

 

Each string comprises of 1 cabinet ID.

 

If providing cabinet, provide only 1 cabinet ID. Only 1 cabinet is currently being supported per cage.

accountNumber Yes string 987  

The account number linked to the cage.

connectionService Yes string COAX

Multi-Mode Fiber,

Single-Mode Fiber,

UTP,

COAX,

POTS

The name of the available connection service media type.

 

Refer to GET Crossconnect Connection Services under the API Reference section for these parameters: connectionService, mediaType, protocolType, connectorType.

mediaType Yes string COAX

50 MICRON MULTI-MODE FIBER OM3,
62.5 MICRON MULTI-MODE FIBER,

Single-Mode Fiber

CAT5e,

CAT6

COAX

CAT3

Name of the sub-media type that corresponds with the connection service media type.

 

Connection service - Name of media type

Multi-Mode Fiber - 50 Micron Multi-Mode Fiber OM3, 62.5 Micron Multi-Mode Fiber, Fiber Channel.

Single-Mode Fiber - Single-Mode Fiber.

UTP - Cat5e, Cat6.
COAX - COAX

POTS - CAT3

 

Media type details can be obtained from using the GET Crossconnect Connection Services API. 

proceedIfMediaCoverterIsRequired No boolean True

true,

false

Requirement for media converter. 

 

If 'true', media converter is required. 

 

If 'false', media converter is not required.

 

Default value: false

 

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

protocolType Yes string ANTENNA

100 GIG ETHERNET,

10 GIG ETHERNET,

40 GIG ETHERNET,

FIBRE CHANNEL,

GIGABIT ETHERNET,

FAST ETHERNET,

DARK FIBER,

DWDM,

OC-12,

OC-192,

OC-3,

OC-48,

STM-1,

STM-16,

STM-4,

STM-64,

56K,

E1,

ETHERNET,

ISDN,

T1,

ANTENNA,

DS-3,

E3,

POTS

Name of the protocol type that corresponds with the name of the media type.

 

Media type - Name of protocol type

50 Micron Multi-Mode Fiber OM3 - 100 Gig Ethernet, 10 Gig Ethernet, 40 Gig Ethernet, Fibre Channel, Gigabit Ethernet.

62.5 Micron Multi-Mode Fiber - Fast Ethernet, Fibre Channel, Gigabit Ethernet.

Single-Mode Fiber - 100 Gig Ethernet, 10 Gig Ethernet, 40 Gig Ethernet, Dark Fibre, DWDM, Fibre Channel, Gigabit Ethernet, OC-12, OC-192, OC-3, OC-48, STM-1, STM-16, STM-4, STM-64.

Cat5e - 56K, E1, Ethernet, Fast Ethernet, Gigabit Ethernet, ISDN, T1.

Cat 6 - 56K, E1, Ethernet, Fast Ethernet, Gigabit Ethernet, ISDN, T1.

COAX - Antenna, DS-3, E3

CAT3 - POTS

 

Protocol type details can be obtained from using the GET Crossconnect Connection Services API. 

connectorType Yes string BNC

BNC, 

FC, 

LC, 

RJ45,

SC,

ST

Name of the connector type that corresponds with the name of the connection service media type.

 

Connection service media type - Name of connector type

Multi-Mode Fiber - LC, SC, ST.

Single-Mode Fiber - FC, LC, SC, ST.

UTP - RJ45.
COAX - BNC, LC.

POTS - RJ45, LC.

 

Connector type details can be obtained from using the GET Crossconnect Connection Services API. 

focDate  No string 2019-07-25T01:59:58.201Z  

An Firm Order Completion (FOC) date is the Carrier Circuit delivery 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.

 

Provide a date and time (UTC timezone) in one of the following ISO 8601 formats:

 

yyyy-MM-dd'T'HH:mm:ssZ,

yyyy-MM-dd'T'HH:mm:ss.SSSZ.

 

If expedited schedule type is selected, this FOC date cannot surpass the date given in the 'requestedCompletionDate' body parameter. 

patchpanel Yes object    

Patch panel information that consists of patch panel serial number and port details.

 

This object contains the following parameters where applicable: name; portA; portB.

 

Refer to GET Crossconnect Patchpanel under the API Reference section for more information. 

name Yes string PP:0102:2345  

Patch panel number. 

portA Yes string Next Available

Next Available

Available port A of patch panel.

portB Conditional string Next Available

Next Available

Available port B of patch panel. This is mandatory depending on the connector type.

 

Connector type - Whether port B is mandatory

BNC - mandatory

FC - mandatory

LC - optional

RJ45 - not necessary

SC - mandatory

ST - mandatory

zside Yes object     

Z-side cross connect information.

 

This object contains the following parameters where applicable: customer; customerAccount; ibxLocation object; connectionService; connectorType; patchpanel object; circuitId; loa array.

 

The following information indicates the mandatory fields for new and existing service providers, both with and without attaching a Letter of Agreement (LOA). 

 

For existing service providers

 

- With LOA: If the provider is an existing service provider and you are attaching an LOA, the following Z-side parameters are mandatory: customerAccount; ibxLocation {ibx}; connectionService; patchpanel (left as blank object);  loa [attachments {id, name}]. The LOA should address all information that is otherwise mandatory. Equinix will contact A and Z sides for further verification before the order can be fulfilled.

 

- Without LOA: If the provider is an existing service provider, the following Z-side parameters are mandatory: customerAccount; ibxLocation {ibx, cages, cage, cabinets}; connectionService, connectorType, patchpanel {name, portA, portB}; circuitId, loa (left as blank array). 

 

For new service providers

 

- With LOA: If the service provider is new and you are attaching an LOA, the following Z-side parameters are mandatory to pass: customerAccount; ibxLocation {ibx}; connectionService; loa [attachments {id, name}]. It is recommended to include the parameter 'customer' to include the new service provider's name. The LOA should address all information that is otherwise mandatory. Equinix will contact A and Z sides for further verification before the order can be fulfilled.

- Without LOA: If you are unable to provide an LOA for the new service provider, the following Z-side parameters are mandatory to pass: customerAccount;  ibxLocation {ibx, cages, cage, cabinets}; connectionService; circuitId; loa (left as blank array). It is recommended to include the parameter 'customer' to include the new service provider's name. Equinix will contact A and Z sides for further verification before the order can be fulfilled. 

customer No string Carigan Communications  

The account name of the service provider. 

 

For existing service providers

Customers may choose to include this.

 

For new service providers

It is recommended for customer to provide the new service provider's name.  

 

Refer to GET Crossconnect Providers under the API Reference section for more information. 

customerAccount Yes string 3988

 

 

-1

The account number of the service provider. 

 

For new service providers
The customer account number must be '-1'. 

 

Refer to GET Crossconnect Providers under the API Reference section for more information. 

ibxLocation Yes object    

IBX location information that consists of the IBX location code, cages information, and cage account number.

 

This object contains the following parameters, where applicable: ibx; cages array.

 

Refer to GET Crossconnect Locations under the API Reference section for more information. 

ibx Yes string DA3  

The IBX location code.

 

For existing service providers
This field is mandatory.

 

For new service providers

This field is mandatory and is free text input with a character range of 1 to 40.

cages Conditional

array

[object]

   

Cages information that consists of cage ID and cabinet ID details.

The object comprises the following parameters where applicable: cage, cabinets array.

 

For existing service providers

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

For new service providers 

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

Only 1 cage is currently supported. Provide information for only 1 cage.

cage Conditional string DA3:001:0100300  

ID of the cage.

 

For existing service providers

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

For new service providers 

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

cabinets Conditional

array

[string]

DA3:001:0100300:00206  

ID of the cabinet.

 

Each string comprises of 1 cabinet ID.

 

For existing service providers

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

For new service providers 

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

Only 1 cabinet ID is currently supported. Provide information for only 1 cabinet.

connectionService Yes string COAX

Multi-Mode Fiber,

Single-Mode Fiber,

UTP,

COAX,

POTS

The name of the available connection service media type.

 

Refer to GET Crossconnect Connection Services under the API Reference section for more information on these parameters: connectionService, connectorType.

connectorType Conditional string BNC

BNC, 

FC, 

LC, 

RJ45,

SC,

ST

Name of the connector type that corresponds with the connection service.

 

Connection service - Connector type

Multi-Mode Fiber - LC, SC, ST.

Single-Mode Fiber - FC, LC, SC, ST.

UTP - RJ45.
COAX - BNC, LC.

POTS - RJ45, LC.

 

For existing service providers

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

For new service providers 

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

Connector type details can be obtained from using the GET Crossconnect Connection Services API. 

patchpanel Conditional object    

Patch panel information that consists of patch panel serial number and port details.


The object comprises the following parameters where applicable: name; portA; portB.

 

For existing service providers

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

For new service providers 

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

Refer to GET Crossconnect Patchpanel under the API Reference section for more information. 

name Conditional string CP:0206:102232  

Patch panel serial number. 

 

For existing service providers

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

For new service providers 

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

portA Conditional string 5

Next Available

Available port A of patch panel.  

 

For existing service providers

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

For new service providers 

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

portB Conditional string Next Available

Next Available

Available port B of patch panel. This is mandatory depending on the connector type.

 

Connector type - Whether port B is mandatory

BNC - mandatory

FC - mandatory

LC - optional

RJ45 - not necessary

SC - mandatory

ST - mandatory

 

For existing service providers

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

For new service providers 

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

circuitId Conditional string 73/HCGS/123456/000/CC  

Customer or carrier circuit ID cable reference number for verification purposes. 

 

For existing service providers

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

For new service providers 

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

loa Yes object    

Letter of Agreement (LOA) information that consists of information for the attached LOAs.

 

This object contains the following parameters where applicable: attachments array.

 

If there is no LOA to attach, this parameter is still mandatory, but the object should be left blank.

attachments No

array

[objects]

   

Attachments array contains objects of LOA attachment information.

 

Each LOA attachment object comprises the following parameters: id; name.

 

Each LOA 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.

 

Refer to POST Attachments File under the API Reference section for more information for more information. 

id Conditional string 0549c413-acc9-4c4b-9067-e7551890b46d  

ID of the attachment. This is mandatory when an attachment is included.

 

You will obtain this value after attaching your file using the attachment API. 

name Conditional string LOA2017/36912.docx  

Name of the attachment. This is mandatory when an attachment is included.

 

You will obtain this value after attaching your file using the attachment API. 

notifyZsideUponCompletion No boolean true

true,

false

Requirement to notify Z-side customer once cross connect is complete.

 

If 'true', Z-side will be notified.

 

If 'false', Z-side will not be notified. 

 

Default value: false

zSideContactEmail No string johndoe@corp.com   Z-side customer email address that will receive notification of cross connect completion. 

This is only required if Z-side must be notified upon completion of the cross connection.
patchEquipment No boolean true

true,

false

Requirement to patch equipment. Smart Hands fees will apply for providing this extension.

 

If 'true', Equinix will install the cross connect from the demarcation panel to your equipment. 

 

If 'false', Equinix will not do any additional installation.

 

Default value: false

device Conditional object    

Device information that Equinix requires to install the cross connect from demarcation panel to customer equipment. This is only required if patching is required.

 

This object contains the following parameters: cabinet; connectorType; details; port.

cabinet Conditional string V0102  

Cabinet number of customer equipment for cross connection. This is only required if patching is needed.

 

The cabinet for patching must belong to the specific cage defined in the A-side details. 

 

The digits that come after the last colon of the cabinet ID is your cabinet number.

 

For example, if the cabinet you wish to patch your equipment has cabinet ID,  'DA1:R1:V0350-1-254:V0102', the cabinet number is 'V0102'.

connectorType Conditional string BNC

BNC, 

FC, 

LC, 

RJ45,

SC,

ST

Device connector type to facilitate cross connection. This is only required if patching is required.

details Conditional string Call the technical contact before patching.  

Additional device details to facilitate cross connection, for customer to provide. This is only required if patching is required.

port Conditional string any available  

Device port number for customer to provide in free text. This is only required if patching is required.

lightLinkVerificationRequired 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, please ensure customer's Z-Side connect partner has their end fully extended to their equipment and their port is enabled. This will incur a fixed fee based on your contract pricing.

 

If 'true', Light Link verification is required.

 

If 'false', Light Link verification is not required.


Default value: false


needSupportFromASubmarineCableStationEngineer
 
Conditional boolean true

true,

false

Requirement for submarine cable station engineer support. This is mandatory for customers with Monet accounts.

 

If 'true', submarine cable station engineer support is required. 

 

If 'false', submarine cable station engineer support is not required and your order will proceed with a standard onsite engineer​.

 

Default value: false

bmmrRequired No boolean     This is not applicable to standard cross connect type at this time. You may ignore this.
connectToOwnCageOrCabinet No boolean     This is not applicable to standard cross connect type at this time. You may ignore this.

 

{
  "OrderReferenceId": "ECP",
  "OrderNumber": "1-189639404838",
  "SRNumber": ""
}

 

The description of the response payload is as follows:

 

Field name Type Example Description
OrderReferenceId string ECP

Equinix internal reference.

 

You may ignore this.

OrderNumber string 1-189639404838 The order number created after order is submitted. 
SRNumber string

 

Equinix internal reference.

 

You may ignore this.

 

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

Order standard cross connect (V1)

Standard CC v2.1

 

If you would like to order multiple cross connects in a single request, see Order multiple cross connects (V1).

Step 1: Authenticate

Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication.

 

Refer to Generating a Client ID and Client Secret key under Getting Started 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: Check Cross Connect Types

To get cross connect types, the user must have Cross Connect & Intra-Facility Cables ordering permission. If you are unaware of your user permissions, contact your Master Administrator. 

 

Get cross connect types

Retrieve the cross connect types that the user has permission to order.
 

Determine if the user can order the preferred cross connect type.

 

Refer to GET Crossconnect Types under the API Reference section for instructions on how to retrieve available cross connect types. You may skip this step if you already know the user has permission to order this cross connect type.

Step 3: Get Cross Connect 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. 

 

3a) Get cross connect location information for the starting point of the cross connect (A-side)

Retrieve the IBX location information for the preferred cross connect type.

 

Determine the exact IBX location code, cage ID, cage account number, and cabinet ID for your A-side criteria.

 

These values will be needed in the subsequent steps to get the required A-side and Z-side details.

 

These values will also be passed in the request body in Step 4 for the following A-side parameters (in the ibxLocation object): ibx, cage, accountNumber, cabinets.

 

Refer to GET Crossconnect Locations under the API Reference section for instructions on how to get all the cross connect location information. You may skip this step if you already know the location information for your A-side.  

 

3b) Get connection services information for your A-side criteria 

Retrieve all the connection services information for the preferred cross connect type.

 

Determine which connection service, media type, connector type, and protocol type to use for your A-side criteria. 

 

This media type value will be needed in Step 3c to get the required patch panel details.

 

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 Crossconnect Connection Services under the API Reference section for instructions on how to retrieve available connection services. You may skip this step if you already know the connection services information for your A-side.

 

3c) Get patch panel information for your A-side criteria 

Retrieve all the patch panel information for the preferred cross connect type. 

 

Determine the patch panel number and the patch panel ports to use for the selected media type.

 

These values will also be passed in the request body in Step 4 for the following A-side parameters (in the patchpanel object): name, portA, portB.

 

Refer to GET Crossconnect Patchpanel under the API Reference section for instructions on how to get all the patch panel information. You may skip this step if you already know the patch panel information for your A-side.  

 

3d) Get service providers information (end point of the cross connect or Z-side)

Retrieve all the service providers information for the preferred cross connect type. 

 

Determine the service provider's account name and account number.

 

The provider's account number will be needed in the subsequent steps to get the required Z-side details.

 

These values will also be passed in the request body in Step 4 for the following Z-side parameters: customer, customerAccount.

 

Refer to GET Crossconnect 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.  

 

3e) Get your Z-side criteria details by repeating steps 3a to 3c 

Retrieve all the same details from steps 3a to 3c for the Z-side criteria.

 

These values will be passed in the request body in Step 4 for the following Z-side parameters: ibx, cage, cabinets, connectionService, connectorType, patchpanel.

 

You may skip this step if you already know your Z-side criteria details.

 

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

Step 4: Order a Standard Cross Connect

POST /crossconnect/standard

 Method  POST
 URL or End Point  /v1/orders/crossconnect/standard
 Headers  Authorization, Content-Type
 Query Parameters  action
 Body

 quantityRequested, customerReferenceNumber, purchaseOrder {purchaseOrderType, attachment {id, name}}, contacts [{contactType, userName}, {contactType, name, email, workPhoneCountryCode, workPhone, workPhonePrefToCall, mobilePhoneCountryCode, mobilePhone, mobilePhonePrefToCall, mobilePhoneTimeZone}]}, schedule {requestedCompletionDate, scheduleType}, additionalDetails, attachments [{id, name}], serviceDetails {aside {ibxLocation {ibx, cages [{cage, cabinets[...], accountNumber}]}, connectionService, mediaType, proceedIfMediaCoverterIsRequired, protocolType, connectorType, focDate, patchpanel {name, portA, portB}}, zside {customer, customerAccount, ibxLocation {ibx, cages [{cage, cabinets[...]}]}, connectionService, connectorType, patchpanel {name, portA, portB}, circuitId, loa {attachments [{id, name}]}, notifyZsideUponCompletion, zSideContactEmail}, patchEquipment, device {cabinet, connectorType, details, port}, lightLinkVerificationRequired, needSupportFromASubmarineCableStationEngineer}

 

This method creates a standard cross connect order for an authenticated user with Cross Connect & Intra-Facility Cables ordering permission. 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 order multiple standard cross connects, see Order multiple cross connects (V1) under the How to Guide.

 

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 screenshots show sample curl requests and JSON response for this API. There is a request for a standard cross connect without additional information or attachment, and a standard cross connect with additional information and attachment. The response indicates the order was successful and returned the order number.

 

Standard cross connect order without additional information or attachment 

 

curl -X

POST 

"https://api.equinix.com/v1/orders/crossconnect/standard?action=SUBMIT"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

-d '{
   "contacts": [
    {
      "contactType": "ORDERING",
      "userName": "johndoe1"
    },
    {
      "contactType": "TECHNICAL",
      "userName": "johndoe1",
      "workPhonePrefToCall": "ANYTIME"
    },
    {
      "contactType": "NOTIFICATION",
      "userName": "johndoe1"
    }
  ],
  "schedule": {
    "requestedCompletionDate": "2019-07-25T01:59:58.201Z",
    "scheduleType": "EXPEDITED"
  },
  "serviceDetails": {
    "aside": {
      "ibxLocation": {
        "ibx": "DA1",
        "cages": [
          {
            "cage": "DA1:R1:V0350-1-254",
            "cabinets": [
              "DA1:R1:V0350-1-254:V001002"
            ],
            "accountNumber": "987"
          }
        ]
      },
      "connectionService": "COAX",
      "mediaType": "COAX",
      "protocolType": "ANTENNA",
      "connectorType": "BNC",
      "patchpanel": {
        "name": "PP:0102:2345",
        "portA": "Next Available",
        "portB": "Next Available"
      }
    },
    "zside": {
      "customerAccount": "3988",
      "ibxLocation": {
        "ibx": "DA3",
        "cages": [
          {
            "cage": "DA3:001:0100300",
            "cabinets": [
              "DA3:001:0100300:00206"
            ]
          }
        ]
      },
      "connectionService": "COAX",
      "connectorType": "BNC",
      "patchpanel": {
        "name": "CP:0206:102232",
        "portA": "5",
        "portB": "Next Available"
      },
      "circuitId": "73/HCGS/123456/000/CC",
      "loa": {
        "attachments": []
      }
    }
  }
}'

 


Standard cross connect order with additional information and attachments

 

Before creating an order with attachment, call the Post Attachment File under the API Reference section.

 

curl -X

POST 

"https://api.equinix.com/v1/orders/crossconnect/standard?action=SUBMIT"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

-d '{
   "quantityRequested": 1,
  "customerReferenceNumber": "SCC138765",
  "purchaseOrder": {
    "purchaseOrderType": "EXEMPTED",
    "attachment": {
      "id": "abc1fd2e-345f-67g4-hi89-01jk234l5m6n",
      "name": "PurchaseOrderExemptionForm123.docx"
    }
  },
  "contacts": [
    {
      "contactType": "ORDERING",
      "userName": "johndoe1"
    },
    {
      "contactType": "TECHNICAL",
      "name": "Jane Smith",
      "email": "janesmith@thiscorp.com",
      "workPhoneCountryCode": "+1",
      "workPhone": "800-322-9280",
      "workPhonePrefToCall": "MY_BUSINESS_HOURS",
      "workPhoneTimeZone": "America/Chicago",
      "mobilePhoneCountryCode": "+1",
      "mobilePhone": "555-555-1234",
      "mobilePhonePrefToCall": "ANYTIME"
    },
    {
      "contactType": "NOTIFICATION",
      "userName": "johndoe1"
    }
  ],
  "schedule": {
    "requestedCompletionDate": "2019-07-25T01:59:58.201Z",
    "scheduleType": "EXPEDITED"
  },
  "additionalDetails": "Refer to attachment.",
  "attachments": [
    {
      "id": "507f8877-4894-4ca6-ac9f-3995c59a4ce6",
      "name": "AdditionalDetailsAttachment.docx"
    }
  ],
  "serviceDetails": {
    "aside": {
      "ibxLocation": {
        "ibx": "DA1",
        "cages": [
          {
            "cage": "DA1:R1:V0350-1-254",
            "cabinets": [
              "DA1:R1:V0350-1-254:V001002"
            ],
            "accountNumber": "987"
          }
        ]
      },
      "connectionService": "COAX",
      "mediaType": "COAX",
      "proceedIfMediaCoverterIsRequired": false,
      "protocolType": "ANTENNA",
      "connectorType": "BNC",
      "focDate": "2019-07-25T01:59:58.201Z",
      "patchpanel": {
        "name": "PP:0102:2345",
        "portA": "Next Available",
        "portB": "Next Available"
      }
    },
    "zside": {
      "customer": "Carigan Communications",
      "customerAccount": "3988",
      "ibxLocation": {
        "ibx": "DA3",
        "cages": [
          {
            "cage": "DA3:001:0100300",
            "cabinets": [
              "DA3:001:0100300:00206"
            ]
          }
        ]
      },
      "connectionService": "COAX",
      "connectorType": "BNC",
      "patchpanel": {
        "name": "CP:0206:102232",
        "portA": "5",
        "portB": "Next Available"
      },
      "circuitId": "73/HCGS/123456/000/CC",
      "loa": {
        "attachments": [
          {
            "id": "0549c413-acc9-4c4b-9067-e7551890b46d",
            "name": "LOA2017/36912.docx"
          }
        ]
      },
      "notifyZsideUponCompletion": true,
      "zSideContactEmail": "johndoe@corp.com"
    },
    "patchEquipment": true,
    "device": {
      "cabinet": "V0102",
      "connectorType": "BNC",
      "details": "Call the technical contact before patching.",
      "port": "any available"
    },
    "lightLinkVerificationRequired": true,
    "needSupportFromASubmarineCableStationEngineer": true
  }
}'

 

The description of the query and request payload is as follows:

 

Query Parameter Name Mandatory Type Example Applicable Values Description
action Yes string

SUBMIT

SUBMIT

The action to submit the order.

 

 

When 'Conditional' is indicated for a Body Parameter, refer to Description for further details. 

 

Body Parameter Name Mandatory Type Example Applicable Values Description
quantityRequested No integer 1 1

Number of cross connects ordered.

 

Default value:1

 

If you would like to order multiple standard cross connects, see Order multiple cross connects (V1) under the How to Guide.

 

If you pass this field with value more than 1, the order will fail. This field will be deprecated in the future. You may ignore this.

customerFollowUpRequired No boolean    

Requirement for customer follow-up.
 

Default value: false
 

Any follow up is directly communicated to the customer.

 

This field will be deprecated in the future. You may ignore this.

customerReferenceNumber No string SCC138765  

Customer reference information for this order. This is free text input.

 

This can be a Purchase Order number or an internal code. This information can be searched for in Order History and will appear within Reports.

 

This field can only be up to 50 characters long. 

purchaseOrder Conditional object    

Purchase order (PO) information details. This is mandatory for PO bearing accounts. 

 

If you do not know your account's PO bearing status, refer to GET Crossconnect Locations under the API Reference section.

purchaseOrderType Conditional string EXEMPTED

EXEMPTED,

EXISTING

Purchase order can be defined as new, existing, or exempted.

 

However, only existing and exempted purchase order types are currently being supported.

 

If 'EXISTING', the blanket purchase order is already known to Equinix and the purchase order number must be sent. Only numbers for blanket purchase orders will be accepted. If you do not have a valid blanket purchase order number, see 'EXEMPTED'.

 

If 'EXEMPTED', there are 2 scenarios where this option applies:-

 

1. A purchase order exemption form has already been submitted and approved, and a purchase order number is not required. No additional information or attachments are required.

 

2. A purchase order exemption request is made together with this order. A Purchase Order Exemption form should be attached to facilitate the exemption request.  

 

This is mandatory for PO bearing accounts. 

number Conditional string    

Blanket purchase order number. This is free text input.

 

This field can only be up to 20 characters long.

 

If the blanket purchase order number submitted throws an error, select 'EXEMPTED' for purchase order type instead.

 

This is mandatory if purchase order type is 'EXISTING'.

attachment Conditional object    

An object containing the attachment details of 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.

 

This should be included when purchase order type is 'EXEMPTED' and you are submitting a Purchase Order Exemption form.

 

Refer to POST Attachments File under the API Reference section for more information. 

id Conditional string abc1fd2e-345f-67g4-hi89-01jk234l5m6n  

ID of the attachment. This is mandatory when an attachment is included.

 

You will obtain this value after attaching your file using the attachment API. 

name Conditional string PurchaseOrderExemptionForm123.docx  

Name of the attachment. This is mandatory when an attachment is included.

 

You will obtain this value after attaching your file using the attachment API, but you may change the name for your own reference when including this attachment in any order request.  This is free text input.

contacts Yes

array

[objects]

   

Contact information consists of the Ordering contact details, Technical contact details, and Notification contact details. 

contactType Yes string ORDERING

ORDERING,

TECHNICAL,

NOTIFICATION

 

There are three types of contact persons: Ordering, Technical, and Notification. All three contacts are mandatory.

 

- Ordering contact person: Person who can submit order. Only one Ordering contact can be passed.

- Technical contact person: Person who Equinix can reach out to for technical clarifications. Only one Technical contact can be passed.

- Notification contact person: Person who will be notified of status updates. At least one notification contact must be provided. If notification contact is not available to pass, use ordering contact as notification contact.

userName Yes string johndoe1  

Equinix-registered username of contact person whose user profile is active or locked. 

 

For Ordering contact, Equinix-registered username of contact person must be active.

 

For Notification and Technical contacts, Equinix-registered username of contact person can be active or locked. 

 

If the Technical contact does not have the required Equinix-registered username, their full name, email address, work phone, and work phone timezone calling preference must be provided. It is recommended to also include the work phone country code. Additional information such as mobile phone country code, mobile phone number, and their availability to take calls on their mobile phone may also be provided.

 

With the exception of the mandatory contact information required for the Technical contact, any other additional contact information passed together with a 'userName' for Ordering, Technical, and Notification contacts will be ignored.

 

E.g. If 'email' and 'workPhone' information is passed with 'userName' for Notification contact, this information will be ignored.

name Conditional string Jane Smith  

Full name of contact person. This is mandatory when the Technical contact does not have an active or locked Equinix-registered username.

 

This is free text input. 

email Conditional string janesmith@thiscorp.com  

Email information of contact person. This is mandatory when the Technical contact does not have an active or locked Equinix-registered username.

 

This is free text input. 

workPhoneCountryCode No string +1  

Country code for work phone number of the contact person. This is free text input. 

 

E.g.: +571

 

It is recommended to include the work phone country code. 

workPhone Conditional string 800-322-9280

 

Work phone number of contact person. This is mandatory when the Technical contact does not have an active or locked Equinix-registered username.

 

This is free text input. 

workPhonePrefToCall Yes string MY_BUSINESS_HOURS

NEVER,
ANYTIME,
MY_BUSINESS_HOURS,
IBX_BUSINESS_HOURS,
BUSINESS_HOURS

Availability of Technical contact person to take calls anytime, during office hours, during their business hours, during the local IBX business hours, during general business hours, or never.

 

This is mandatory when the Technical contact does not have an active or locked Equinix-registered username.

 

If 'MY_BUSINESS_HOURS', the additional body parameter 'workPhoneTimeZone' is mandatory.

workPhoneTimeZone Conditional string America/Chicago Click here for applicable values.

This indicates the specific timezone of the Technical contact's business hours that follows the IANA time zone database names format. This is mandatory when 'MY_BUSINESS_HOURS' is selected for 'workPhonePrefToCall'.

 

E.g. Area/Location

mobilePhoneCountryCode No string +1

 

Mobile phone number country code of contact person. This is free text input. 

 

Example: +571

mobilePhone No string 555-555-1234  

Mobile phone number of contact person. This is free text input. 

mobilePhonePrefToCall No string ANYTIME

NEVER,
ANYTIME,
MY_BUSINESS_HOURS,
IBX_BUSINESS_HOURS,
BUSINESS_HOURS

Availability of Technical contact person to take calls on their mobile phone anytime, during office hours, during their business hours, during the local IBX business hours, during general business hours, or never.

 

If 'MY_BUSINESS_HOURS', the additional body parameter 'mobilePhoneTimeZone' is mandatory. 

mobilePhoneTimeZone Conditional string   Click here for applicable values.

This indicates the specific timezone of the Technical contact's business hours that follows the IANA time zone database names format.

 

E.g. Area/Location

 

This should be included when 'MY_BUSINESS_HOURS' is selected for 'mobilePhonePrefToCall' and the mobile phone timezone differs from the work phone timezone. If 'mobilePhoneTimeZone' is not included, it will be assumed that both the work phone and mobile phone timezones are the same. 

schedule Yes

object

    Scheduling information for the installation of the cross connect order.  
requestedCompletionDate Conditional string 2019-07-25T01:59:58.201Z  

Requested completion date and time of scheduled cross connect installation. 

 

Expedited scheduling date should not be less than IBX local time + 2 hours, and no more than IBX local time + 24 hours.

 

If 'EXPEDITED' schedule type, provide a date and time (UTC timezone) in one of the following ISO 8601 formats:

 

yyyy-MM-dd'T'HH:mm:ssZ,

yyyy-MM-dd'T'HH:mm:ss.SSSZ.

 

In the case of 'STANDARD' schedule type, this parameter is not required.

scheduleType Yes string EXPEDITED

EXPEDITED,

STANDARD

Define your preferred scheduling type.

 

These are the scheduling types supported for this cross connect.

 

Schedule Types 
 

STANDARD: Request will be processed in the standard turnaround time. Most requests are completed within 24 to 72 hours pending your install base readiness. Requests will be processed in the order they were received, unless they are expedited.
- Parameter 'requestedCompletionDate' is not required. 

 

EXPEDITED: Request will be completed within the next 2 to 24 hours. Additional Smart Hands fees may apply. Schedule a time in the current local time of the IBX you selected. Equinix will contact customer for schedule negotiation if preferred scheduling cannot be met.
- Parameter 'requestedCompletionDate' is required. 

additionalDetails No string Refer to attachment.  

Additional details the Equinix Technician may need to complete your request. This is free text input.

 

This field can only be up to 4000 characters long.

attachments No

array

[objects]

   

Additional attachment. Provide any other supportive photos or documents to help the technician to complete your order. 

 

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

 

Refer to POST Attachments File under the API Reference section for more information. 

id Conditional string 507f8877-4894-4ca6-ac9f-3995c59a4ce6  

ID of the attachment. This is mandatory when an attachment is included.

 

You will obtain this value after attaching your file using the attachment API. 

name Conditional string AdditionalDetailsAttachment.docx  

Name of the attachment. This is mandatory when an attachment is included.

 

You will obtain this value after attaching your file using the attachment API, but you may change the name for your own reference when including this attachment in any order request. This is free text input. 

serviceDetails Yes object   

 

Service details information consisting of the A-side (starting point of cross connect) and Z-side (end point of cross connect) locations and their corresponding cross connect details. 

aside Yes object     

A-side cross connect information that consists of IBX location information, connection service, media type, media converter requirement, protocol type, connector type, and patch panel information.

ibxLocation Yes object    

IBX location information that consists of the IBX location code, cages information, and cage account number.

 

Refer to GET Crossconnect Locations under the API Reference section for more information. 

ibx Yes string DA1  

The IBX location code.

cages Yes

array

[object]

   

Cages information consists of ID of cage, ID of cabinet, and cage account number.

 

Only 1 cage per order is currently being supported. Provide information for only 1 cage.

cage Yes string DA1:R1:V0350-1-254  

ID of the cage.

cabinets Yes

array

[string]

DA1:R1:V0350-1-254:V001002  

ID of the cabinet.

 

Only 1 cabinet is currently being supported per cage .Provide information for only 1 cabinet.

accountNumber Yes string 987  

The account number linked to the cage.

connectionService Yes string COAX

Multi-Mode Fiber,

Single-Mode Fiber,

UTP,

COAX,

POTS

The name of the available connection service media type.

 

Refer to GET Crossconnect Connection Services under the API Reference section for more information on these parameters: connectionService, mediaType, protocolType, connectorType.

mediaType Yes string COAX

50 MICRON MULTI-MODE FIBER OM3,
62.5 MICRON MULTI-MODE FIBER,

Single-Mode Fiber

CAT5e,

CAT6

COAX

CAT3

Name of the sub-media type that corresponds with the connection service media type.

 

Connection service - Name of media type

Multi-Mode Fiber - 50 Micron Multi-Mode Fiber OM3, 62.5 Micron Multi-Mode Fiber, Fiber Channel.

Single-Mode Fiber - Single-Mode Fiber.

UTP - Cat5e, Cat6.
COAX - COAX

POTS - CAT3

 

Media type details can be obtained from using the GET Crossconnect Connection Services API. 

proceedIfMediaCoverterIsRequired No boolean True

true,

false

Requirement for media converter. 

 

If 'true', media converter is required. 

 

If 'false', media converter is not required.

 

Default value: false

 

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

protocolType Yes string ANTENNA

100 GIG ETHERNET,

10 GIG ETHERNET,

40 GIG ETHERNET,

FIBRE CHANNEL,

GIGABIT ETHERNET,

FAST ETHERNET,

DARK FIBER,

DWDM,

OC-12,

OC-192,

OC-3,

OC-48,

STM-1,

STM-16,

STM-4,

STM-64,

56K,

E1,

ETHERNET,

ISDN,

T1,

ANTENNA,

DS-3,

E3,

POTS

Name of the protocol type that corresponds with the name of the media type.

 

Media type - Name of protocol type

50 Micron Multi-Mode Fiber OM3 - 100 Gig Ethernet, 10 Gig Ethernet, 40 Gig Ethernet, Fibre Channel, Gigabit Ethernet.

62.5 Micron Multi-Mode Fiber - Fast Ethernet, Fibre Channel, Gigabit Ethernet.

Single-Mode Fiber - 100 Gig Ethernet, 10 Gig Ethernet, 40 Gig Ethernet, Dark Fibre, DWDM, Fibre Channel, Gigabit Ethernet, OC-12, OC-192, OC-3, OC-48, STM-1, STM-16, STM-4, STM-64.

Cat5e - 56K, E1, Ethernet, Fast Ethernet, Gigabit Ethernet, ISDN, T1.

Cat 6 - 56K, E1, Ethernet, Fast Ethernet, Gigabit Ethernet, ISDN, T1.

COAX - Antenna, DS-3, E3

CAT3 - POTS

 

Protocol type details can be obtained from using the GET Crossconnect Connection Services API. 

 

connectorType Yes string BNC

BNC, 

FC, 

LC, 

RJ45,

SC,

ST

Name of the connector type that corresponds with the name of the connection service media type.

 

Connection service media type - Name of connector type

Multi-Mode Fiber - LC, SC, ST.

Single-Mode Fiber - FC, LC, SC, ST.

UTP - RJ45.
COAX - BNC, LC.

POTS - RJ45, LC.

 

Connector type details can be obtained from using the GET Crossconnect Connection Services API. 

focDate  No string 2019-07-25T01:59:58.201Z  

An FOC (Firm Order Completion) date is the Carrier Circuit delivery 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.

 

Provide a date and time (UTC timezone) in one of the following ISO 8601 formats:

 

yyyy-MM-dd'T'HH:mm:ssZ,

yyyy-MM-dd'T'HH:mm:ss.SSSZ.

 

If expedited schedule type is selected, this FOC date cannot surpass the date given in the 'requestedCompletionDate' body parameter. 

patchpanel Yes object    

Patch panel information that consists of patch panel serial number and port details.

 

Refer to GET Crossconnect Patchpanel under the API Reference section for more information. 

name Yes string PP:0102:2345  

Patch panel number. 

 

Patch panel and port availability information details can be obtained from using the GET Crossconnect Patchpanel API. 

portA Yes string Next Available

Next Available

Available port A of patch panel.

 

Patch panel and port availability information details can be obtained from using the GET Crossconnect Patchpanel API. 

portB Conditional string Next Available

Next Available

Available port B of patch panel. This is mandatory depending on the connector type.

 

Connector type - Whether port B is mandatory

BNC - mandatory

FC - mandatory

LC - optional

RJ45 - not necessary

SC - mandatory

ST - mandatory

 

Patch panel and port availability information details can be obtained from using the GET Crossconnect Patchpanel API. 

zside Yes object     

Z-side cross connect information that consists of customer account name, customer account number, IBX location information, connection service, media type, media converter requirement, protocol type, connector type, and patch panel information. 

 

The following information indicates the mandatory fields for new and existing service providers, both with and without attaching a Letter of Agreement (LOA). 

 

For existing service providers

 

- With LOA: If the provider is an existing service provider and you are attaching an LOA, the following Z-side parameters are mandatory: customerAccount, ibxLocation, ibx, connectionService, patchpanel (left as blank object),  loa, attachments, id, name. The LOA should address all information that is otherwise mandatory. Equinix will contact A and Z sides for further verification before the order can be fulfilled.

 

- Without LOA: If the provider is an existing service provider, the following Z-side parameters are mandatory: customerAccount, ibxLocation, ibx, cages, cage, cabinets, connectionService, connectorType, patchpanel, name, portA, portB, circuitId, loa, attachments, id, name. 

 

For new service providers

 

- With LOA: If the service provider is new and you are attaching an LOA, the following Z-side parameters are mandatory to pass: customerAccount, ibxLocation, ibx, connectionService, loa, attachments, id, name. It is recommended to include the parameter 'customer' to include the new service provider's name. The LOA should address all information that is otherwise mandatory. Equinix will contact A and Z sides for further verification before the order can be fulfilled.

- Without LOA: If you are unable to provide an LOA for the new service provider, the following Z-side parameters are mandatory to pass: customerAccount, ibxLocation, ibx, cages, cage, cabinets, connectionService, circuitId, and loa (left as blank object). It is recommended to include the parameter 'customer' to include the new service provider's name. Equinix will contact A and Z sides for further verification before the order can be fulfilled.

customer No string Carigan Communications  

The account name of the service provider. 

 

For existing service providers

Customers may choose to include this.

 

For new service providers

It is recommended for customer to provide the new service provider's name.  

 

Refer to GET Crossconnect Providers under the API Reference section for more information. 

customerAccount Yes string 3988

 

 

-1

The account number of the service provider. 

 

For new service providers
The customer account number must be '-1'. 

 

Refer to GET Crossconnect Providers under the API Reference section for more information. 

ibxLocation Yes object    

IBX location information that consists of the IBX location code, cages information, and cage account number.

 

Refer to GET Crossconnect Locations under the API Reference section for more information. 

ibx Yes string DA3  

The IBX location code.

 

For existing service providers
This field is mandatory.

 

For new service providers

This field is mandatory and is free text input with a character range of 1 to 40.

cages Conditional

array

[object]

   

Cages information that consists of cage ID and cabinet ID details.

 

For existing service providers

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

For new service providers 

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

Only 1 cage per order is currently being supported. Provide information for only 1 cage.

cage Conditional string DA3:001:0100300  

ID of the cage.

 

For existing service providers

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

For new service providers 

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

cabinets Conditional

array

[string]

DA3:001:0100300:00206  

ID of the cabinet.

 

For existing service providers

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

For new service providers 

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

Only 1 cabinet is currently being supported per cage .Provide information for only 1 cabinet.

connectionService Yes string COAX

Multi-Mode Fiber,

Single-Mode Fiber,

UTP,

COAX,

POTS

The name of the available connection service media type.

 

Refer to GET Crossconnect Connection Services under the API Reference section for more information for these parameters: connectionService, connectorType.

connectorType Conditional string BNC

BNC, 

FC, 

LC, 

RJ45,

SC,

ST

Name of the connector type that corresponds with the connection service.

 

Connection service - Connector type

Multi-Mode Fiber - LC, SC, ST.

Single-Mode Fiber - FC, LC, SC, ST.

UTP - RJ45.
COAX - BNC, LC.

POTS - RJ45, LC.

 

For existing service providers

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

For new service providers 

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

Connector type details can be obtained from using the GET Crossconnect Connection Services API. 

patchpanel Conditional object    

Patch panel information that consists of patch panel serial number and port details.

 

For existing service providers

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

For new service providers 

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

Refer to GET Crossconnect Patchpanel under the API Reference section for more information. 

name Conditional string CP:0206:102232  

Patch panel serial number. 

 

For existing service providers

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

For new service providers 

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

Patch panel and port availability information details can be obtained from using the GET Crossconnect Patchpanel API.  

portA Conditional string 5

Next Available

Available port A of patch panel. 

 

For existing service providers

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

For new service providers 

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

Patch panel and port availability information details can be obtained from using the GET Crossconnect Patchpanel API. 

portB Conditional string Next Available

Next Available

Available port B of patch panel. This is mandatory depending on the connector type.

 

Connector type - Whether port B is mandatory

BNC - mandatory

FC - mandatory

LC - optional

RJ45 - not necessary

SC - mandatory

ST - mandatory

 

For existing service providers

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

For new service providers 

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

Patch panel and port availability information details can be obtained from using the GET Crossconnect Patchpanel API. 

circuitId Conditional string 73/HCGS/123456/000/CC  

Customer or carrier circuit ID cable reference number for verification purposes. 

 

For existing service providers

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

 

For new service providers 

- With LOA: This field is optional.

- Without LOA: This field is mandatory.

loa Yes object    

Letter of Agreement (LOA) information that consists of the attachments information.

 

If there is no LOA to attach, this parameter is still mandatory, but the object should be left blank.

attachments No array[objects]    

LOA file attachment information that consists of attachment ID and attachment name. 

 

Each LOA 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.

 

Refer to POST Attachments File under the API Reference section for more information for more information. 

id Conditional string 0549c413-acc9-4c4b-9067-e7551890b46d  

ID of the attachment. This is mandatory when an attachment is included.

 

You will obtain this value after attaching your file using the attachment API. 

name Conditional string LOA2017/36912.docx  

Name of the attachment. This is mandatory when an attachment is included.

 

You will obtain this value after attaching your file using the attachment API, but you may change the name for your own reference when including this attachment in any order request. This is free text input. 

notifyZsideUponCompletion No boolean true

true,

false

Requirement to notify Z-side customer once cross connect is complete.

 

If 'true', Z-side will be notified.

 

If 'false', Z-side will not be notified. 

 

Default value: false

zSideContactEmail No string johndoe@corp.com   Z-side customer email address that will receive notification of cross connect completion. 
patchEquipment No boolean true

true,

false

Requirement to patch equipment. Smart Hands fees will apply for providing this extension.

 

If 'true', Equinix will install the cross connect from the demarcation panel to your equipment. 

 

If 'false', Equinix will not do any additional installation.

 

Default value: false

device Conditional object    

Device information that Equinix requires to install the cross connect from demarcation panel to customer equipment. 

 

This is only required if patching is required.

cabinet Conditional string V0102  

Cabinet number of customer equipment for cross connect. This is only required if patching is required.

 

The cabinet for patching must belong to the specific cage defined in the A-side details. 

connectorType Conditional string BNC

BNC, 

FC, 

LC, 

RJ45,

SC,

ST

Device connector type to facilitate cross connect.

 

This is only required if patching is required.

details Conditional string Call the technical contact before patching.  

Additional device details to facilitate cross connect, for customer to provide.  This is only required if patching is required.

port Conditional string any available  

Device port number for customer to provide in free text.  This is only required if patching is required.

lightLinkVerificationRequired 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, please ensure customer's Z-Side connect partner has their end fully extended to their equipment and their port is enabled. This will incur a fixed fee based on your contract pricing.

 

If 'true', Light Link verification is required.

 

If 'false', Light Link verification is not required.


Default value: false


needSupportFromASubmarineCableStationEngineer
 
Conditional boolean true

true,

false

Requirement for submarine cable station engineer support. This is mandatory for customers with Monet accounts.

 

If 'true', submarine cable station engineer support is required. 

 

If 'false', submarine cable station engineer support is not required and your order will proceed with a standard onsite engineer​.

 

Default value: false

bmmrRequired No boolean     This is not applicable to 'STANDARD' cross connect type at this time. You may ignore this.
connectToOwnCageOrCabinet No boolean     This is not applicable to 'STANDARD' cross connect type at this time. You may ignore this.

 

{
  "OrderReferenceId": "ECP",
  "OrderNumber": "1-189639404838",
  "SRNumber": ""
}

 

The description of the response payload is as follows:

 

Field name Type Example Description
OrderReferenceId string ECP

Equinix internal reference.

 

You may ignore this.

OrderNumber string 1-189639404838 The order number created after order is submitted. 
SRNumber string

 

Equinix internal reference.

 

You may ignore this.

 

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