Skip to main content
Index

CrossConnect (V1)

CrossConnect (V1) APIs allow a user with Cross Connect & Intra-Facility Cables ordering permission to get their available cross connect types, location information, service providers, connection services, and patch panel information, as well as place cross connect orders.

GET Crossconnect Connection Services

GET /crossconnect/connectionservices

 Method  GET
 URL or End Point  /v1/orders/crossconnect/connectionservices
 Headers  Authorization, Content-Type
 Query Parameters  ibx, side, asideIbx, providerAccountNo, crossConnectType     
 Body  Not applicable

 

The Get crossconnect connectionservices API returns all available connections services within the requested IBX where the user has 'Cross Connect & Intra-Facility Cables' 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 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 a sample curl request and JSON response for this API. The response indicates the available cross connection services for a Fiber cross connect type for a Z-side IBX location, NY7, Z-side provider account number, 111977, and A-side IBX location, NY2.

 

curl -X

GET "https://api.equinix.com/v1/orders/crossconnect/connectionservices?ibx=MI1&side=Z_SIDE&asideIbx=MI2&providerAccountNo=566040&crossConnectType=STANDARD"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

The description of the query parameters is as follows:

 

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

 

Query Parameter Name Mandatory Type Example Applicable Values Description
ibx Yes string MI1  

The IBX location code that represents the IBX data center that the user has access to. 

 

This can be for A-side (starting point of cross connect) or Z-side (end point of cross connect) IBX location(s), depending on the 'side' query parameter.

 

E.g. AM1 represents an IBX in Amsterdam, Netherlands.

side Conditional string Z_SIDE

A_SIDE,

Z_SIDE

Defines the query 'ibx' as A-side (starting point of cross connect) or Z-side (end point of cross connect). 

Default value: A_SIDE

 

If 'A_SIDE', the information returned will be based on the A-side 'ibx' query parameter.

If 'Z_SIDE', the information returned will be based on the Z-side 'ibx' query parameter. Additional query parameters 'asideIbx' and 'accountNumber' must be included.

 

This is a mandatory query parameter when searching for Z-side service provider details.

asideIbx Conditional string

MI2

 

The IBX location code of the A-side.

 

This is a mandatory query parameter when the 'Z_SIDE' value is selected for the 'side' query parameter.

providerAccountNo Conditional string 566040  

The service provider's cage account number (Z-side). 

 

This is a mandatory query parameter when the 'Z_SIDE' value is selected for the 'side' query parameter.

 

In the case of  'INTRA_CUSTOMER' cross connect type, the provider account number will be the A-side account number.

crossConnectType Conditional string STANDARD

STANDARD,

INTRA_CUSTOMER,

EXTENDED,

FIBER,

FIBER_EXTENDED

The cross connect type that is available to the user. 

 

Default value: STANDARD

 

Applicable Value- cross connect type

STANDARD- Standard Cross Connect,  

INTRA_CUSTOMER- Intra-Customer Cross Connect,

EXTENDED- Extended Cross Connect,

FIBER- Fiber Connect,

FIBER_EXTENDED- Extended Fiber Connect.

 

Only orders for 'STANDARD' and 'INTRA_CUSTOMER' cross connect types are currently supported.

 

This is a mandatory query parameter when searching for Z-side service provider details.

 

[
  {
    "name": "COAX",
    "mediaType": [
      {
        "name": "COAX",
        "protocolType": [
          {
            "name": "DS-3",
            "connectorType": [
              "BNC",
              "LC"
            ]
          } 
        ],
        "circuitCount": []
      }
    ]
  },
  {
    "name": "Multi-Mode Fiber",
    "mediaType": [
      {
        "name": "62.5 MICRON MULTI-MODE FIBER OM1",
        "protocolType": [
          {
            "name": "10 GIG ETHERNET",
            "connectorType": [
              "SC",
              "LC",
              "ST",
              "FC"
            ]
          }
        ],
        "circuitCount": []
      },
      {
        "name": "62.5 MICRON MULTI-MODE FIBER",
        "protocolType": [
          {
            "name": "GIGABIT ETHERNET",
            "connectorType": [
              "LC",
              "SC",
              "FC",
              "ST"
            ]
          },
          {
            "name": "FAST ETHERNET",
            "connectorType": [
              "SC",
              "LC",
              "ST",
              "FC"
            ]
          },
          {
            "name": "FIBRE CHANNEL",
            "connectorType": [
              "SC",
              "LC",
              "FC",
              "ST"
            ]
          }
        ],
        "circuitCount": []
      }
    ]
  }
]

 

 

The description of the response payload is as follows:

 

Field name Type Example Description
name string COAX The name of the available connection service.
mediaType array [objects]   Media type information that consists of media type name and protocol type information.
name string

COAX

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

 

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

protocolType array [objects]   The protocol type information consists of name of the protocol type and connector type, that correspondents with the media type.
name string DS-3

Name of the protocol type that corresponds with 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

connectorType array [string] BNC, LC

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

 

Connection service - 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

circuitCount array  

Intra-Faciltiy Cable (IFC) circuit count options available for the respective connection service.

 

E.g. If the 'circuitCount' is empty, it means there are no available IFC circuits. If '3,6' appears in the circuit count, it means that the IFC circuits options available are 3 circuits and 6 circuits.

 

Depending on the connection service, the circuit count may range from 3 circuits to 48 circuits.

 

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

GET Crossconnect Locations

GET /crossconnect/locations

 Method  GET
 URL or End Point  /v1/orders/crossconnect/locations
 Headers  Authorization, Content-Type
 Query Parameters

 ibxs, crossConnectType, cages, detail, 

side, asideIbx, accountNumber 

Body  Not applicable

 

The Get crossconnect locations API returns all IBX locations, accounts, cages and cabinets information for a given A-side or Z-side criteria. This can only be done when the user has 'Cross Connect & Intra-Facility Cables' 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 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 a sample curl request and JSON response for this API. The response returned all available Z-side locations information for the Z-side provider with cage accouunt number, 560980, in IBX locations, AT1 and AT3, for a Fiber cross connect from A-side IBX location, AT2. Detailed locations information was also requested.

 

curl -X

GET "https://api.equinix.com/v1/orders/crossconnect/locations?ibxs=AT1,AT3&crossConnectType=STANDARD&detail=true&side=Z_SIDE&asideIbx=AT2&accountNumber=560980"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

The description of the query parameters is as follows:

 

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

 

Query Parameter Name Mandatory Type Example Applicable values Description
ibxs No string AT1,AT3  

The IBX location code that represents the IBX data center(s) that the user has access to.

 

This can be for A-side (starting point of cross connect) or Z-side (end point of cross connect) IBX location(s), depending on the 'side' query parameter.

 

By specifying single or multiple IBX names (e.g.: AM1 or AM1,AM2,AM3), the constraint is placed on specific IBX locations.

 

To return all IBX locations that the user has access to, do not include this parameter. 

To return all IBX locations for the Z-side criteria, do not include this parameter.

crossConnectType No string STANDARD

STANDARD,

INTRA_CUSTOMER,

EXTENDED,

FIBER,

FIBER_EXTENDED,

DEINSTALL,

IFC

The type of cross connect services.

 

Default value: STANDARD

 

Cross connect type- Description

STANDARD- Standard Cross Connect,  

INTRA_CUSTOMER- Intra-Customer Cross Connect,

EXTENDED- Extended Cross Connect,

FIBER- Fiber Connect,

FIBER_EXTENDED- Extended Fiber Connect,

DEINSTALL- Cross Connect Removal,

IFC- Intra-Facility Cable

 

Only orders for 'STANDARD' and 'INTRA_CUSTOMER' cross connect types are currently supported.

cages No string    

ID of the cage that the user has access to.

 

By specifying ID of the cage or cages (e.g.: AM1:0G:00EQ11 or AM1:0G:00EQ11,AM1:0G:00EQ11-1), the constraint is placed on specific cages.

 

To return all cages that the user has access to, do not include this parameter. 

 

Do not include this parameter when searching for Z-side location details unless you know the exact Z-side cage ID number.

detail No boolean true

true,

false

To determine whether the locations information returned is detailed.

 

Default value : false

 

If 'true', locations information returned will include IBX locations and their corresponding cage, account, and cabinet details, and any other cross connect type-specific details. 

 

If 'false', only the IBX locations IDs will be returned.

side Conditional string Z_SIDE

A_SIDE,

Z_SIDE.

Defines the query 'ibx' as A-side (starting point of cross connect) or Z-side (end point of cross connect). 

 

Default value : A_SIDE

 

If 'A_SIDE', the information returned will be based on the A-side 'ibx' query parameter.

 

If 'Z_SIDE', the information returned will be based on the Z-side 'ibx' query parameter. Additional query parameters 'asideIbx' and 'accountNumber' must be included.

 

This is a mandatory query parameter when searching for Z-side service provider details.

asideIbx Conditional string AT2  

The IBX location code of the A-side.

 

This is a mandatory query parameter when the 'Z_SIDE' value is selected for the 'side' query parameter.

accountNumber  Conditional string 560980  

The service provider's account number (Z-side) linked to their cage. 

 

This is a mandatory query parameter when the 'Z_SIDE' value is selected for the 'side' query parameter.

 

{
  "locations": [
    {
      "ibx": "AT1",
      "cages": [
        {
          "cage": "AT1:02:028298",
          "cageReference": "ATA2AS191_CAG",
          "accounts": [
            {
              "number": "529480",
              "name": "John Smith, Inc.",
              "poTracking": false,
              "pricingEnabled": false,
              "pricingEnforced": false,
              "cabinets": [
                {
                  "cabinet": "AT1:02:028298:0107",
                  "cabinetReference": "ls99at5",
                  "cabinetType": "Cabinet"
                }
              ],
              "isCreditHold": false,
              "isPOBearing": false,
              "isMonetAccount": false
            }
          ]
        }
      ],
      "isCampusCrossConnectAvailable": true
    }
  ]
}

 

The description of the response payload is as follows:

 

Field name Type Example Description
locations array [objects]   The IBX locations information which consists of the IBX location code and cages information. Additional information may be included depending on the cross connect type.
ibx string AT1 The IBX location code that represents the IBX.
cages array [objects]

 

Cages information that consists of cage ID, and account information.
cage string AT1:02:028298 ID of the cage.
cageReference string ATA2AS191_CAG Legacy cage reference number. 
accounts array [objects]   Account information of this cage that consists of customer account number, customer account name, purchase order tracking status, pricing enabled status, cabinets information, credit status of account, PO number requirement from account, and MonetAccount classification.
number string 529480 The customer account number linked to the cage.
name string John Smith, Inc. The customer account name linked to the cage.
poTracking boolean false

Indicates if purchase order tracking is required for the customer account.

 

You may ignore this. 

pricingEnabled

boolean

false

Indicates if the pricing needs to be provided at the time of ordering for this customer account.

 

You may ignore this. 

pricingEnforced boolean false 

Indicates if a pricing acknowledgment needs to be received from user before an order is submitted for this customer account.

 

You may ignore this. 

cabinets array [objects]   Cabinets information that consists of the cabinet ID and the customer cabinet reference number.
cabinet string AT1:02:028298:0107 ID of the cabinet that the user has access to.
cabinetReference string ls99at5 Customer's cabinet reference number. 
cabinetType string Cabinet

Type of cabinet.

 

Cabinet type - Description 

Cabinet - Cabinet that is not a demarcation point for a cross connection.
Demarcation point - Cabinet that is a demarcation point for a cross connection.

isCreditHold boolean false

Credit status of the customer account.

 

If 'true', customer account is unable to place billable orders.

 

If 'false', customer account is free to make orders.

isPOBearing boolean false

Purchase order bearing status of customer account.

 

If 'true', it is mandatory to include the purchase order details when placing billable orders. 

 

If 'false', purchase order number is not required. 

isMonetAccount boolean false

Indicates that this account has cages that require submarine engineering support.

 

If 'true', the field "needSupportFromASubmarineCableStationEngineer" must be provided when placing orders.

 

If 'false', no additional field is required when placing orders. 

isCampusCrossConnectAvailable boolean true

Indicates if the standard cross connect (when searching for the Z-side location) is also a campus cross connect.

 

If 'true', campus cross connect is available. This indicates that the distance between the A-side and Z-side IBXs is short (typically does not exceed 10km over single-mode fiber).

 

If campus cross connect is unavailable, this field will not appear.

 

This does not result in any deviation from a standard cross connect order. 

 

You may ignore this. 

avgDistance string  

The average distance in kilometres for the connection ordered.

 

This field only appears for Fiber and Fiber Extended cross connect types.

avgDbLoss string  

The average dB signal loss at 1550 nm for the connection ordered.

 

This field only appears for Fiber and Fiber Extended cross connect types.

nccType string  

Defines the Extended cross connect type as a regular Extended cross connect or an Extended Fiber cross connect.

 

This field only appears for Extended and Extended Fiber cross connect types.

 

If '-', the cross connect type is Extended.

 

If 'Extended Fiber Connect', cross connect type is Extended Fiber.

 

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

GET Crossconnect Patchpanel

GET /crossconnect/patchpanel

 Method  GET
 URL or End Point  /v1/orders/crossconnect/patchpanel
 Headers  Authorization, Content-Type
 Query Parameters

 name, ibx, cage, cabinet, mediaType, accountNumber, legacyName, side,asideIbx, providerAccountNo, 

 crossConnectType

 Body  Not applicable

 

The Get crossconnect patchpanel API returns patch panel information to a user with 'Cross Connect & Intra-Facility Cables' 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 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 request for a patch panel search based on two scenarios: (A) when you do not know the patch panel serial number (search by IBX location ID, cage ID, cabinet ID, sub-media type, and cage account number), and (B) when you know the patch panel serial number (search by patch panel serial number).

 

If you do not know your patch panel serial number, you will need to start with scenario (A) and move on to scenario (B) to get the necessary patch panel information.

 

If you already know your patch panel serial number, you only need to start with scenario (B).

 

In the case of (A), the JSON response for this API returns a summary of the patch panels available and their general information.

 

In the case of (B), the JSON response for this API returns more detailed information of the individual patch panel. 

 

(A) When you do not know the patch panel serial number - Search by IBX location ID, cage ID, cabinet ID, sub-media type, and cage account number

 

curl -X

GET "https://api.equinix.com/v1/orders/crossconnect/patchpanel?ibx=MI1&cage=MI1:02:122100&cabinet=MI1:02:122100:0112&mediaType=CAT3&accountNumber=350858"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

The description of the query parameters is as follows:

 

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

 

Query Parameter name Mandatory Type Example Applicable values Description
name No string     The serial number of the patch panel.

E.g. CP:0112:13468516 or PP:0123:13467890
ibx Yes string MI1  

The IBX location code that represents the IBX data center. 

 

E.g. MI1 represents an IBX in Miami, Florida, United States.

cage Yes string MI1:02:122100   ID of the cage.
cabinet Yes string

MI1:02:122100

  ID of the cabinet.
legacyName No string     Legacy serial number of the patch panel.
mediaType No string CAT3

50 MICRON MULTI-MODE FIBER OM3,

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

62.5 MICRON MULTI-MODE, FIBER OM1,

OS1,

Single-Mode Fiber,

CAT3,

CAT5e,

CAT6,

CAT6A,

CAT6a,

COAX

Name of the media type.

 

Refer to GET Crossconnect Connection Services in the API Reference section for more information on the connection services and its media type, protocol type, and connector type details. 

side Conditional string  

A_SIDE,

Z_SIDE

Defines the query search for patch panel information for the A-side (starting point of cross connect) or Z-side (end point of cross connect). 

 

Default value: A-side.

 

If 'Z-SIDE', the 'ibx', 'cage', and 'cabinet' service providers will apply to the Z-side criterion.

 

If 'A-SIDE', the 'ibx', 'cage', and 'cabinet' service providers will apply to the A-side criterion.

 

This is a mandatory query parameter when searching for Z-side service provider patch panel details.

asideIbx Conditional string    

The IBX location code for A-side.

 

This is a mandatory query parameter when the 'Z_SIDE' is selected for the 'side' query parameter.

providerAccountNo Conditional string    

The service provider's account number (Z-side). 

 

This is a mandatory query parameter when the 'Z_SIDE' is selected for the 'side' query parameter.

accountNumber Yes string 350858   Cage account number of the user's organization (A-side). 
crossConnectType No string  

STANDARD,
INTRA_CUSTOMER,

EXTENDED,
FIBER,
FIBER_EXTENDED

Type of cross connect. 

 

Cross connect type - Description

STANDARD- Standard Cross Connect

INTRA_CUSTOMER- Intra-Customer Cross Connect

EXTENDED- Extended Cross Connect

FIBER- Fiber Connect

FIBER_EXTENDED- Extended Fiber Connect.

 

Only orders for 'STANDARD' and 'INTRA_CUSTOMER' cross connect types are currently supported.

 

{
  "ppNumberList": [
    "CP:0112:13468516,72,48,NAPMIA.2CB151.107.02.08:49/50",
    "PP:0112:1142910,48,1,"
  ],
  "ppDetailList": [
    {
      "ppNumber": "CP:0112:13468516",
      "maxPorts": "72",
      "availablePorts": "24",
      "patchPanelRefNo": "NAPMIA.2CB151.107.02.08:49/50"
    },
    {
      "ppNumber": "PP:0112:1142910",
      "maxPorts": "48",
      "availablePorts": "47",
      "patchPanelRefNo": ""
    }
  ],
  "installReq": false,
  "lcAllowed": false,
  "ifcPanel": false,
  "circuitAvailable": true
}

 

The description of the response payload is as follows:

 

Field name

Type

Example

Description

ppNumberList

array[strings]

CP:0112:13468516,72,48,NAPMIA.2CB151.107.02.08:49/50

The list of all available patch panels based on the search, arranged in ascending order by patch panel serial number. 

 

The patch panel serial number is followed by numbers that are a summary of the total maximum number of ports, the total number of unavailable ports, and the patch panel reference number.

 

E.g. patch panel serial number,total maximum number of ports,total number of unavailable ports,customer patch panel reference number 

ppDetailList

array[objects

 

A list of information about the patch panel that consists of the patch panel serial number, the total maximum number of ports, the total number of available ports, and the customer patch panel reference number. 

ppNumber

string

CP:0112:13468516

The serial number of the patch panel.

maxPorts

string

72

Total maximum number of ports on the patch panel.

availablePorts

string

24

Total number of remaining available ports on the patch panel.

patchPanelRefNo

string

NAPMIA.2CB151.107.02.08:49/50

Customer patch panel reference number. 

installReq

boolean

false

Installation requirement of patch panel.

 

If 'true', Equinix will install the cross connect from the demarcation panel to customer equipment. Smart Hands fees will apply for providing this extension.

 

If 'false', Equinix will not install the cross connect from the demarcation panel to customer equipment. false

lcAllowed

boolean

false

LC Connectors connection status.

 

If 'true', LC connectors are allowed to be connected. This is only for Multi-Moder Fibe or Single-Mode Fiber protocol types.

 

If 'false', LC connectors are not allowed to be connected.

ifcPanel

boolean

false

To identify if the patch panel needs an intra-facility cable (IFC) connection.

 

If 'true', IFC connection is required.

 

If 'false', IFC connection is not required. 

circuitAvailable

boolean

true

To indicate if circuits are available for the patch panel.

 

If 'true', circuits are available.

 

If 'false', circuits are not available.

 

(B) When you know the patch panel serial number - Search by patch panel serial number

 

curl -X

GET "https://api.equinix.com/v1/orders/crossconnect/patchpanel?name=CP:0112:13468516"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

The description of the query parameters is as follows:

 

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

 

Query Parameter name Mandatory Type Example Applicable values Description
name Yes string CP:0112:13468516  

The serial number of the patch panel.

 

E.g. CP:0112:13468516 or PP:0123:13467890

ibx No string    

The IBX location code that represents the IBX data center.

 

E.g. MI1 represents an IBX in Miami, Florida, United States.

cabinet No string

 

  ID of the cabinet.
legacyName No string     Legacy serial number of the patch panel.
mediaType No string  

50 MICRON MULTI-MODE FIBER OM3,

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

62.5 MICRON MULTI-MODE, FIBER OM1,

OS1,

Single-Mode Fiber,

CAT3,

CAT5e,

CAT6,

CAT6A,

CAT6a,

COAX

Name of the media type.

 

Refer to GET Crossconnect Connection Services in the API Reference section for more information on the connection services and its media type, protocol type, and connector type details. 

side Conditional string  

A_SIDE,

Z_SIDE

Defines the query search for patch panel information for the A-side (starting point of cross connect) or Z-side (end point of cross connect). 

 

Default value: A-side.

 

If 'Z-SIDE', the 'ibx', 'cage', and 'cabinet' service providers will apply to the Z-side criterion.

 

If 'A-SIDE', the 'ibx', 'cage', and 'cabinet' service providers will apply to the A-side criterion.

 

This is a mandatory query parameter when searching for Z-side service provider patch panel details.

asideIbx Conditional string    

The IBX location code for A-side.

 

This is a mandatory query parameter when the 'Z_SIDE' is selected for the 'side' query parameter.

providerAccountNo Conditional string    

The service provider's account number (Z-side). 

 

This is a mandatory query parameter when the 'Z_SIDE' is selected for the 'side' query parameter.

accountNumber No string 350858   Cage account number of the user's organization (A-side). 
crossConnectType No string   STANDARD,
EXTENDED,
INTRA_CUSTOMER,
FIBER,
FIBER_EXTENDED

Type of cross connect. 

 

Only orders for 'STANDARD' and 'INTRA_CUSTOMER' cross connect types are currently supported.

 

{
  "ibx": "MI1",
  "cage": "MI1:02:122100",
  "accountName": "JOHN DOE CORP.",
  "accountNumber": "350858",
  "dedicatedMediaType": "Mixed",
  "prewired": "No",
  "maxPorts": "72",
  "ppType": "Customer provided",
  "customerPanelRefNumber": "JDC.394750.204.20.08:49/50",
  "rackLoc": "Front",
  "installLoc": "",
  "installReq": false,
  "lcAllowed": false,
  "ifcPanel": false,
  "circuitAvailable": true,
  "mediaTypes": [
    "62.5 MICRON MULTI-MODE FIBER",
    "COAX"
  ],
  "availablePorts": [
    49,
    50,
    51,
    52,
    53,
    54,
    55,
    56,
    57,
    58,
    59,
    60,
    61,
    62,
    63,
    64,
    65,
    66,
    67,
    68,
    69,
    70,
    71,
    72
  ],
  "reservedPorts": [
    {
      "port": "53",
      "reservedByUsername": "JOHN DOE",
      "reservedByEmail": "johndoe@jdc.com"
    },
    {
      "port": "54",
      "reservedByUsername": "JOHN DOE",
      "reservedByEmail": "johndoe@jdc.com"
    }
  ],
  "invalidPorts": [
    1,
    2,
    3,
    4,
    5,
    6,
    7,
    8,
    9,
    10,
    11,
    12,
    13,
    14,
    15,
    16,
    17,
    18,
    19,
    20,
    21,
    22,
    23,
    24,
    25,
    26,
    27,
    28,
    29,
    30,
    31,
    32,
    33,
    34,
    35,
    36,
    37,
    38,
    39,
    40,
    41,
    42,
    43,
    44,
    45,
    46,
    47,
    48
  ],
  "usedPorts": [
    55,
    66
  ],
  "connectionServices": [
    {
      "name": "COAX",
      "mediaType": [
        {
          "name": "COAX",
          "protocolType": [
            {
              "name": "DS-3",
              "connectorType": [
                "BNC"
              ]
            }
          ],
          "circuitCount": []
        }
      ]
    },
    {
      "name": "Multi-Mode Fiber",
      "mediaType": [
        {
          "name": "62.5 MICRON MULTI-MODE FIBER",
          "protocolType": [
            {
              "name": "GIGABIT ETHERNET",
              "connectorType": [
                "SC",
                "FC",
                "ST"
              ]
            },
            {
              "name": "FAST ETHERNET",
              "connectorType": [
                "SC",
                "ST",
                "FC"
              ]
            },
            {
              "name": "FIBRE CHANNEL",
              "connectorType": [
                "SC",
                "FC",
                "ST"
              ]
            }
          ],
          "circuitCount": [
            3,
            6,
            12,
            24,
            48
          ]
        }
      ]
    }
  ],
  "portSerial": {
    "55": "10.GE.100112.0013.10-W",
    "66": "20976231"
  },
  "ppNumber": "CP:0112:13468516",
  "cabinetNumber": "0112"
}

 

The description of the response payload is as follows:

 

Field name Type Example Description
ibx string MI1

The IBX location code that represents the IBX data center.

 

E.g. MI1 represents an IBX in Miami, Florida, United States.

cage string MI1:02:122100 ID of the cage.
accountName string

JOHN DOE CORP.

Cage account name of the customer.
accountNumber string 350858 Cage account number of the customer. 
dedicatedMediaType string Mixed Type of dedicated media. 
prewired string No

Pre-wire status of cross connects.

If 'yes', cross connects are pre-wired.

 

If 'no', cross-connects are not pre-wired.


maxPorts
 
string 72 Total number of ports.

ppType
 
string Customer provided Type of patch panel.
customerPanelRefNumber string JDC.394750.204.20.08:49/50 Customer's own patch panel reference number.

rackLoc
 
string Front Rack location of patch panel.

installLoc
 
string   Installation location of patch panel.

installReq
 
boolean false

Installation requirement of patch panel.

 

If 'true', Equinix will install the cross connect from the demarcation panel to customer equipment. Smart Hands fees will apply for providing this extension.

 

If 'false', Equinix will not install the cross connect from the demarcation panel to customer equipment. 


lcAllowed
 
boolean false

LC Connectors connection status.

 

If 'true', LC connectors are allowed to be connected. This is only for Multi-Moder Fibe or Single-Mode Fiber protocol types.

 

If 'false', LC connectors are not allowed to be connected.


ifcPanel
 
boolean false

To identify if the patch panel needs an intra-facility cable (IFC) connection.

 

If 'true', IFC connection is required.

 

If 'false', IFC connection is not required. 


circuitAvailable
 
boolean true

To indicate if circuits are available for the patach panel.

 

If 'true', circuits are available.

 

If 'false', circuits are not available.


mediaTypes
 
array[strings]

COAX, 

62.5 MICRON MULTI-MODE FIBER

Name of the media type available.

 

Refer to GET Crossconnect Connection Services in the API Reference section for more information on the connection services and its media type, protocol type, and connector type details. 


availablePorts
 
array 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72 Individually identified ports that are available out of the total number of ports.
reservedPorts array[objects]   Information of reserved ports that consists of port number, username and email of details of the user who reserved the port. 
port string 53 Individually identified port that was reserved.
reservedByUsername string JOHN DOE Username of the user who reserved the port.
reservedByEmail string johndoe@jdc.com Email address of the user who reserved the port.
invalidPorts

array

1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 

13, 14, 15,16, 17, 18, 19, 20, 21, 

22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 

40, 41, 42, 43, 44, 45, 46, 47, 48

Individually identified ports that are invalid and unavailable. 
usedPorts array

55, 66

Individually identified ports that are currently in use.

connectionServices
 
array[objects]  

Connection services information that consists of available media type, protocol type and connector type details, which corresponds to the name of connection service. 

 

Refer to GET Crossconnect Connection Services in the API Reference section for more information on the connection services and its media type, protocol type, and connector type details. 


name
 
string COAX Name of the available connection service.

mediaType
 
array[objects]   Media type information that consists of media type name and protocol type information.

name
 
string COAX Name of the media type that correponds with the connection service.

protocolType
 
array[objects]   The protocol type information consists of name of the protocol type and connector type, that correspondents with the media type.

name
 
string DS-3 Name of the protocol type that corresponds with the name of the media type.

connectorType
 
array[strings] BNC List of the names of connector types that correspond with the name of the connection service.

circuitCount
 
array 3, 6, 12, 24, 48

Intra-Faciltiy Cable (IFC) circuit count options available for the respective connection service.

 

E.g. If '3, 6, 12, 24, 48' appears in the circuit count, it means that the IFC circuits options available are 3 circuits, 6 circuits, 12 circuits, 24 circuits, and 48 circuits.

 

Depending on the connection service, the circuit count may range from 3 circuits to 48 circuits.

portSerial object   Individually identified port numbers and the corresponding serial numbers of ports in use. 
55 string 10.GE.100112.0013.10-W Port number 55 has serial number 10.GE.100112.0013.10-W.
66  string 20976231  Port number 66 has serial number 20976231. 

ppNumber
 
string
CP:0112:13468516
The patch panel serial number.

cabinetNumber
 
string
0112
 
Cabinet number that the patch panel is located in. 

 

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

GET Crossconnect Providers

GET /crossconnect/providers

 Method  GET
 URL or End Point  /v1/orders/crossconnect/providers
 Headers  Authorization, Content-Type
 Query Parameters  crossConnectType, ibx, cage, account, connectTo
 Body  Not applicable

 

The Get crossconnect providers API returns all available crossconnect service providers to the user with 'Cross Connect & Intra-Facility Cables' 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 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 a sample curl request for service providers of standard cross connects services in cage MI1:02:122100 of IBX location, MI1, and a JSON response containing these service providers arranged in ascending alphabetical order.

 

curl -X

GET "https://api.equinix.com/v1/orders/crossconnect/providers?crossConnectType=FIBER&ibx=MI1&cage=MI1:02:122100&account=241041&connectTo=SERVICE_PROVIDER"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

The description of the query parameters is as follows:

 

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

 

Query Parameter Name Mandatory Type Example Applicale values Description
crossConnectType Yes string FIBER

STANDARD,

INTRA_CUSTOMER,

EXTENDED,
FIBER

The type of cross connect services available to the user.

 

Cross connect type - Description

STANDARD- Standard Cross Connect,  

INTRA_CUSTOMER- Intra-Customer Cross Connect,

EXTENDED- Extended Cross Connect,

FIBER- Fiber Connect

 

 

Only orders for 'STANDARD' and 'INTRA_CUSTOMER' cross connect types are currently supported.

ibx Yes string MI1  

The IBX location code that represents the IBX data center. 

 

E.g. MI1 represents an IBX in Miami, Florida, United States.

cage Yes string MI1:02:122100   ID of the cage that the user has access to.
account Yes string 241041   The cage account number of the user.
connectTo Conditional string SERVICE_PROVIDER

SELF,

SERVICE_PROVIDER

Defines the query based on if the user wants to establish a Fiber cross connect with their own equipment, or with a service provider.

 

SELF is applicable when the customer wants to connect to their own equipment in a different IBX. e.g. own cage or cabinet.

SERVICE_PROVIDER is applicable when the customer wants to connect to a service provider in a different IBX.   

 

This is a mandatory query parameter only when the value 'FIBER' is selected for the query parameter 'crossConnectType' .

 

 

[
  {
    "accountNo": "547940",
    "name": "Ecbiznet, Inc."
  },
  {
    "accountNo": "204726",
    "name": "EQUINIX"
  },
  {
    "accountNo": "241041",
    "name": "John Doe Corp."
  },
  {
    "accountNo": "974268",
    "name": "Webhosting.Net"
  }
]

 

 

The description of the response payload is as follows:

 

Field name Type Example Description
accountNo string 302429 The cage account number of the service provider.
name string 31173 Services AB The cage name of the service provider.

 

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

GET Crossconnect Types

GET /crossconnect/types

 Method  GET
 URL or End Point  /v1/orders/crossconnect/types
 Headers  Authorization, Content-Type
 Query Parameters  Not applicable
 Body  Not applicable

 

The Get crossconnect types API returns all interconnection products available to the user including cross connects types, network port types, and interconnection services based on their '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 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 a sample curl request and JSON response for this API. The response indicates that a user can order cross connects, network ports, and additional services.

 

curl -X

GET "https://api.equinix.com/v1/orders/crossconnect/types"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

{
  "crossconnects": [
    {
      "type": "STANDARD",
      "typeDescription": "Cross Connect",
      "disabled": false
    },
    {
      "type": "INTRA_CUSTOMER",
      "typeDescription": "Intra-Customer Cross Connect",
      "disabled": false
    },
    {
      "type": "EXTENDED",
      "typeDescription": "Extended Cross Connect",
      "disabled": true
    },
    {
      "type": "FIBER",
      "typeDescription": "Fiber Cross Connect",
      "disabled": true
    },
    {
      "type": "DEINSTALL",
      "typeDescription": "Cross Connect Removal",
      "disabled": false
    }
  ],
  "interconnectionservices": [
    {
      "type": "INSTALL_PATCH_CABLE",
      "typeDescription": "Install Patch Cable",
      "disabled": false
    },
    {
      "type": "INTRA_FACILITY_CABLE",
      "typeDescription": "intraFacilityCable",
      "disabled": true
    }
  ],
  "networkports": [
    {
      "type": "METRO_CONNECT_PORT",
      "typeDescription": "Metro Connect Port",
      "disabled": true
    },
    {
      "type": "INTERNET_EXCHANGE_PORT",
      "typeDescription": "Internet Exchange Port",
      "disabled": true
    },
    {
      "type": "CLOUD_EXCHANGE_PORT",
      "typeDescription": "Cloud Exchange Port",
      "disabled": true
    }
  ]
}

 

The description of the response payload is as follows:

 

Field name Type Example Description
crossconnects array [objects]  

The cross connects available to the user. This is one of three product categories. The other two are network ports, and interconnection services.

 

Cross connects consist of Standard Cross Connect, Intra-Customer Cross Connect, Extended Cross Connect or Extended Fiber Cross Connect, Fiber Connect, and Cross Connect Removal.

 

User must have 'Cross Connect & Intra-Facility Cables' ordering permission to order these cross connects.

 

Only orders for 'STANDARD' and 'INTRA_CUSTOMER' cross connect types are currently supported.

 

You may ignore all other types and products.

type string STANDARD

The interconnection products that are available to the user based on the product category. 

Product category - Product type 

Cross connects - Standard, Intra-customer, Extended, Fiber, Deinstall.

Interconnections services - Install Patch Cable, Intra Facility Cable. 

Network ports - Metro connect port, Internet Exchange Port, Cloud Exchange Port. 

 

Only orders for 'STANDARD' and 'INTRA_CUSTOMER' cross connect types are currently supported.

 

You may ignore all other types and products.

typeDescription string Cross Connect A short description of the corresponding type of product. 
disabled boolean

false

This is a general display control for the type of cross connect available to a user in the UI customer portal based on their ordering permissions for specific IBXs.

 

If 'true', the option to order this specific cross connect is disabled for the user, and will not be displayed in the UI customer portal.

If 'false', the option to order this specific cross connect is enabled for the user, and will be displayed in the UI customer portal. This means that the user has 'Cross Connect & Intra- Facility Cables' permission at an IBX that has this service. 

 

E.g. Overall, the user can order Standard, Intra-customer, and Deinstall cross connects. This means that they have 'Cross Connect & Intra-Facility Cables' ordering permission at selected IBX locations that are enabled for these services. 

 

Only orders for 'STANDARD' and 'INTRA_CUSTOMER' cross connect types are currently supported.

 

You may ignore all other types and products.

interconnectionservices array [objects]  

The interconnection services available to the user.

 

These consist of Patch Cable Installation, and Intra-Facility Cable.

 

User must have 'Smart Hands & Accessories' ordering permission to order Patch Cable Installation, and 'Cross Connect & Intra-Facility Cables' ordering permission to order Intra-Facility Cable.

 

Only orders for 'STANDARD' and 'INTRA_CUSTOMER' cross connect types are currently supported.

 

You may ignore this.

networkports array [objects]  

The network ports that are available to the user.

 

These consist of Metro connect, Internet Exchange Port, and Cloud Exchange Port. 

 

User must have 'Network Ports' ordering permission to order these network ports.

 

Only orders for 'STANDARD' and 'INTRA_CUSTOMER' cross connect types are currently supported.

 

You may ignore this.

 

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