[Skip to main content](#__docusaurus_skipToContent_fallback) [![Equinix Logo](https://cdn.equinix.com/microfrontends/console/static/images/logos/eqx-brand-horizontal.svg)![Equinix Logo](https://docs.equinix.com/img/Equinix_logo_horizontal_reversed_RGB.svg)](https://docs.equinix.com/index.md) [**Docs**](https://docs.equinix.com/index.md) [English](#) * [English](https://docs.equinix.com/api-catalog/crossconnectsv2.md) * [日本語](https://docs.equinix.com/ja/api-catalog/crossconnectsv2) * [Português (Brasil)](https://docs.equinix.com/pt-BR/api-catalog/crossconnectsv2) * [Español](https://docs.equinix.com/es/api-catalog/crossconnectsv2) * [简体中文](https://docs.equinix.com/zh-Hans/api-catalog/crossconnectsv2) * [Français canadien](https://docs.equinix.com/fr-CA/api-catalog/crossconnectsv2) * [Français](https://docs.equinix.com/fr/api-catalog/crossconnectsv2) Search Search... * Cross Connects * postOrder cross connects * patchUpdate a cross connects order * postPlace cross connect deinstallation order [API docs by Redocly](https://redocly.com/redoc/) # Cross Connect (2.0) Download OpenAPI specification:[Download](openapi.yaml) URL: [Terms of Service](https://www.equinix.com/about/legal/terms) A Cross Connect is a physical cable connection that uses a coaxial, fiber or sometimes copper cable to connect customers equipment directly to other customers equipment inside Equinix data centers. Since cross connects transmit data point-to-point between computing systems inside our facility, they are not susceptible to the latency or congestion problems of the public Internet and can be relied upon to operate at consistently high speeds. ## [](#tag/Cross-Connects)Cross Connects Cross Connects ## [](<#tag/Cross-Connects/operation/Order cross connects>)Order cross connects This method creates an order for single or multiple standard cross connects at locations where a user has cross connects ordering permission. ##### Authorizations: *BearerAuth* ##### Request Body schema: application/json | | | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | | customerReferenceId | string \[ 1 .. 40 ] charactersCustomer Reference Identifier / External Reference Identifier | | attachments | Array of objects (Attachment\_Request) <= 5 itemsFile(s) attached to the Cross Connect | | Array (<= 5 items)id string = 36 characters Identifier of the binary attachment UUID. name string \[ 5 .. 100 ] characters Name of the binary attachment. | | | description | string \[ 0 .. 4000 ] charactersDescription of Cross Connect | | expediteDateTime | string \Expedite orders are delivered within the next 2 - 24 hours. Value must be in ISO-8601 UTC timezone format. | | detailsrequired | Array of objects (Layer1\_Details) \[ 1 .. 10 ] itemsCross connections details | | Array (\[ 1 .. 10 ] items)aSide required object (aSide) A-Side source patch panel to establish connection to another customer. Connections Service , Media Type and Protocol Type is mandatory to establish new connection. zSide required zSideWithLOA (object) or zSideWithPatchPanel (object) (zSide) Z-Side can be an existing or a new customer without patch panel. For an existing customer, only patchPanel and connectorType are required. For a new customer or patch panel, providerName, ibx, and loaAttachmentId are required diverseConnections object (diverseConnections) Diversified cross connect or redundant cross connect for the availability. If its a new redundant connection, A-Side and Z-Side is mandatory. If it is existing connection, Cross Connect serial number and type is mandatory. verifyLink boolean When true, light link verification is carried out. This may incur fixed fee based on your contract pricing. circuitDeliveryDate string \ Carrier Circuit Delivery Date submarineEngineerRequired boolean Default: false Set to true if submarine cable station engineer is required. | | | purchaseOrder | object (purchaseOrder)Purchase Order | | type required string Default: "EXEMPTED" Enum: "EXEMPTED" "NEW" "EXISTING" Type of the Purchase Order number required string Purchase order number is applicable when type is EXISTING or NEW amount number This is only applicable when type is NEW startDate string \ This is only applicable when type is NEW endDate string \ This is only applicable when type is NEW attachmentId string = 36 characters Attachment ID of Purchase Order document. | | | contacts | Array of ContactRequestRegisteredUser (object) or ContactRequestNonRegisteredUser (object) | | ArrayAny ofContactRequestRegisteredUserContactRequestNonRegisteredUserregisteredUsers required Array of strings <= 10 items Username of a registered user. availability string Default: "ANYTIME" Enum: "WORK\_HOURS" "ANYTIME" Contact's availability to receive calls. timezone string (TIME\_ZONE\_LIST) Enum: "Atlantic/Canary" "Europe/Dublin" "Europe/London" "Europe/Lisbon" "Africa/Algiers" "Europe/Berlin" "Europe/Amsterdam" "Europe/Copenhagen" "Europe/Madrid" "Europe/Paris" "Europe/Stockholm" "Europe/Zurich" "Europe/Warsaw" "Africa/Cairo" "Africa/Johannesburg" "Africa/Lagos" "Europe/Sofia" "Africa/Nairobi" "Asia/Jerusalem" "Europe/Istanbul" "Europe/Moscow" "Asia/Riyadh" "Asia/Dubai" "Asia/Kabul" "Asia/Tehran" "Asia/Karachi" "Indian/Maldives" "Asia/Kolkata" "Asia/Kathmandu" "Asia/Omsk" "Asia/Rangoon" "Asia/Jakarta" "Asia/Ho\_Chi\_Minh" "Asia/Brunei" "Asia/Hong\_Kong" "Asia/Kuala\_Lumpur" "Asia/Manila" "Asia/Shanghai" "Asia/Singapore" "Asia/Taipei" "Australia/Perth" "Asia/Seoul" "Asia/Tokyo" "Australia/Darwin" "Australia/Brisbane" "Pacific/Guam" "Australia/Adelaide" "Australia/Sydney" "Pacific/Auckland" "Pacific/Chatham" "Indian/Christmas" "America/Scoresbysund" "Atlantic/South\_Georgia" "America/Sao\_Paulo" "America/Detroit" "America/New\_York" "America/Puerto\_Rico" "America/Toronto" "America/Bogota" "America/Chicago" "America/Winnipeg" "America/Denver" "America/Edmonton" "America/Mexico\_City" "America/Los\_Angeles" "America/Vancouver" "America/Phoenix" "America/Anchorage" "America/Halifax" "America/Lima" "America/Monterrey" "Pacific/Gambier" "Pacific/Marquesas" "Pacific/Honolulu" "Pacific/Fiji" "Asia/Muscat" "America/Argentina/Buenos\_Aires" "America/Caracas" "Etc/GMT+12" "UTC" "GMT" "America/Santiago" "America/St\_Johns" "Asia/Almaty" "Asia/Bangkok" "Asia/Calcutta" "Asia/Magadan" "Asia/Yekaterinburg" "Australia/Eucla" "Australia/Lord\_Howe" "Europe/Bratislava" "Europe/Brussels" "Europe/Prague" "Europe/Rome" "Europe/Helsinki" "Pacific/Kiritimati" "Pacific/Midway" "Pacific/Tongatapu" "Australia/Melbourne" "Australia/NSW" "Australia/Queensland" "Australia/South" "Australia/Victoria" "Australia/West" "Australia/Canberra" Time Zone Enum values. type required string Default: "NOTIFICATION" Enum: "NOTIFICATION" "TECHNICAL" Note that only one technical contact is allowed. | | ### Responses **201** Layer 1 Created | | | | -------- | ------------------------------------------------------------------ | | Location | stringExample: "/orders/1-23232322"Location on newly created layer | **400** Bad Request **403** Forbidden **500** Internal Server Error post/colocations/v2/orders/crossConnects https\://api.equinix.com/colocations/v2/orders/crossConnects https\://sandboxapi.equinix.com/colocations/v2/orders/crossConnects ### Request samples * Payload Content type application/json Example new\_provider\_payloadnew\_provider\_payload Copy Expand all Collapse all `{ "customerReferenceId": "Customer Reference information free text", "description": "Please provide any additonal details the technician may need to complete your request.", "details": [ { "aSide": { "connectionService": "COAX", "mediaType": "COAX", "protocolType": "E3", "connectorType": "BNC", "patchPanel": { "id": "CP:0104:0123129", "portA": 10, "portB": 11 } }, "zSide": { "providerName": "New Customer Name for connections", "ibx": "AM1", "connectionService": "COAX", "loaAttachmentId": "85d9660a-f877-405a-b38e-8e61a4f77f44" } } ], "purchaseOrder": { "type": "NEW", "amount": 10000, "startDate": "2020-03-04", "endDate": "2021-03-04", "attachmentId": "85d9660a-f877-405a-b38e-8e61a4f77f44" }, "attachments": [ { "id": "85d9660a-f877-405a-b38e-8e61a4f77f44", "name": "additionalattachment.docx" } ], "contacts": [ { "type": "TECHNICAL", "firstName": "John'", "lastName": "Doe", "availability": "WORK_HOURS", "timezone": "America/New_York", "details": [ { "value": "johndoe@acme.com", "type": "EMAIL" }, { "value": "+65-1111111", "type": "PHONE" }, { "value": "+65-1111111", "type": "MOBILE" } ] }, { "registeredUsers": [ "johndoe@acme.com" ], "type": "NOTIFICATION" } ] }` ### Response samples * 400 * 403 * 500 Content type application/json Example single\_field\_errorsingle\_field\_error Copy Expand all Collapse all `[ { "errorCode": "EQ-2012025", "errorMessage": "Selected value is not in allowed list of values", "correlationId": "99740113403329", "additionalInfo": [ { "property": "connectorService", "reason": "Selected code is invalid. Allowed list are COAX, MP4_CABLE, MULI_MODE_FIBER, POTS, SINGLE_MODE_FIBER, UTP", "value": "CO_AX" } ] } ]` ## [](<#tag/Cross-Connects/operation/Update a Cross Connect Order>)Update a cross connects order This method updates a cross connects order by its ID for a user with permission to view this request. ##### Authorizations: *BearerAuth* ##### path Parameters | | | | --------------- | -------------------------------------------------------------------- | | orderIdrequired | string \[ 1 .. 100 ] charactersIdentifier of the cross connect order | ##### Request Body schema: application/jsonrequired The cross connect to be updated | | | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | | contacts | Array of objects (ContactRequestRegisteredUser\_Update) <= 1 items | | Array (<= 1 items)registeredUsers required Array of strings \[ 1 .. 10 ] items Username for the registered user party type required string Value: "NOTIFICATION" Type of contact | | ### Responses **202** Accepted **204** No content **400** Bad Request **403** Forbidden **500** Internal Server Error patch/colocations/v2/orders/crossConnects/{orderId} https\://api.equinix.com/colocations/v2/orders/crossConnects/{orderId} https\://sandboxapi.equinix.com/colocations/v2/orders/crossConnects/{orderId} ### Request samples * Payload Content type application/json Copy Expand all Collapse all `{ "contacts": [ { "registeredUsers": [ "john_doe" ], "type": "NOTIFICATION" } ] }` ### Response samples * 400 * 403 * 500 Content type application/json Copy Expand all Collapse all `[ { "errorCode": "EQ-2012025", "errorMessage": "Selected value is not in allowed list of values.", "correlationId": "210407001942756", "additionalInfo": [ { "property": "contacts[0].type", "reason": "Selected contacts[0].type is invalid. Allowed list is NOTIFICATION", "value": "NOTIFICATIO" } ] } ]` ## [](<#tag/Cross-Connects/operation/Place cross connect deinstallation order>)Place cross connect deinstallation order This API allows user to initiate a cross connect deinstallation request. Cross connect asset will be removed according to order placed. ##### Authorizations: *BearerAuth* ##### Request Body schema: application/json | | | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | customerReferenceId | string \[ 1 .. 40 ] charactersCustomer Reference Identifier / External Reference Identifier | | purchaseOrder | object (purchaseOrder)Purchase Order | | type required string Default: "EXEMPTED" Enum: "EXEMPTED" "NEW" "EXISTING" Type of the Purchase Order number required string Purchase order number is applicable when type is EXISTING or NEW amount number This is only applicable when type is NEW startDate string \ This is only applicable when type is NEW endDate string \ This is only applicable when type is NEW attachmentId string = 36 characters Attachment ID of Purchase Order document. | | | contacts | Array of ContactRequestRegisteredUser (object) or ContactRequestNonRegisteredUser (object) | | ArrayAny ofContactRequestRegisteredUserContactRequestNonRegisteredUserregisteredUsers required Array of strings <= 10 items Username of a registered user. availability string Default: "ANYTIME" Enum: "WORK\_HOURS" "ANYTIME" Contact's availability to receive calls. timezone string (TIME\_ZONE\_LIST) Enum: "Atlantic/Canary" "Europe/Dublin" "Europe/London" "Europe/Lisbon" "Africa/Algiers" "Europe/Berlin" "Europe/Amsterdam" "Europe/Copenhagen" "Europe/Madrid" "Europe/Paris" "Europe/Stockholm" "Europe/Zurich" "Europe/Warsaw" "Africa/Cairo" "Africa/Johannesburg" "Africa/Lagos" "Europe/Sofia" "Africa/Nairobi" "Asia/Jerusalem" "Europe/Istanbul" "Europe/Moscow" "Asia/Riyadh" "Asia/Dubai" "Asia/Kabul" "Asia/Tehran" "Asia/Karachi" "Indian/Maldives" "Asia/Kolkata" "Asia/Kathmandu" "Asia/Omsk" "Asia/Rangoon" "Asia/Jakarta" "Asia/Ho\_Chi\_Minh" "Asia/Brunei" "Asia/Hong\_Kong" "Asia/Kuala\_Lumpur" "Asia/Manila" "Asia/Shanghai" "Asia/Singapore" "Asia/Taipei" "Australia/Perth" "Asia/Seoul" "Asia/Tokyo" "Australia/Darwin" "Australia/Brisbane" "Pacific/Guam" "Australia/Adelaide" "Australia/Sydney" "Pacific/Auckland" "Pacific/Chatham" "Indian/Christmas" "America/Scoresbysund" "Atlantic/South\_Georgia" "America/Sao\_Paulo" "America/Detroit" "America/New\_York" "America/Puerto\_Rico" "America/Toronto" "America/Bogota" "America/Chicago" "America/Winnipeg" "America/Denver" "America/Edmonton" "America/Mexico\_City" "America/Los\_Angeles" "America/Vancouver" "America/Phoenix" "America/Anchorage" "America/Halifax" "America/Lima" "America/Monterrey" "Pacific/Gambier" "Pacific/Marquesas" "Pacific/Honolulu" "Pacific/Fiji" "Asia/Muscat" "America/Argentina/Buenos\_Aires" "America/Caracas" "Etc/GMT+12" "UTC" "GMT" "America/Santiago" "America/St\_Johns" "Asia/Almaty" "Asia/Bangkok" "Asia/Calcutta" "Asia/Magadan" "Asia/Yekaterinburg" "Australia/Eucla" "Australia/Lord\_Howe" "Europe/Bratislava" "Europe/Brussels" "Europe/Prague" "Europe/Rome" "Europe/Helsinki" "Pacific/Kiritimati" "Pacific/Midway" "Pacific/Tongatapu" "Australia/Melbourne" "Australia/NSW" "Australia/Queensland" "Australia/South" "Australia/Victoria" "Australia/West" "Australia/Canberra" Time Zone Enum values. type required string Default: "NOTIFICATION" Enum: "NOTIFICATION" "TECHNICAL" Note that only one technical contact is allowed. | | | attachments | Array of objects (Attachment\_Request) <= 5 itemsFile(s) attached to the layer #1 connections | | Array (<= 5 items)id string = 36 characters Identifier of the binary attachment UUID. name string \[ 5 .. 100 ] characters Name of the binary attachment. | | | description | string \[ 0 .. 4000 ] charactersDescription of deinstallation | | detailsrequired | Array of objects (Layer1\_Deinstall\_Details) \[ 1 .. 10 ] itemslayer #1 connections details | | Array (\[ 1 .. 10 ] items)assetId required string Asset ID of the cross connect you wish to de-install proceedWithLiveTraffic boolean When true, Equinix will proceed with deinstallation request despite detecting live traffic. patchEquipment object | | | removalDaterequired | string \Equinix will aim to terminate this Cross Connect at this date subjected to operation availability. | ### Responses **201** Layer 1 deinstall requested | | | | -------- | ------------------------------------------------------------------------------ | | Location | stringExample: "/orders/1-23232322"Location on newly created deinstall request | **400** Bad Request **403** Forbidden **500** Internal Server Error post/colocations/v2/orders/crossConnects/deinstall https\://api.equinix.com/colocations/v2/orders/crossConnects/deinstall https\://sandboxapi.equinix.com/colocations/v2/orders/crossConnects/deinstall ### Request samples * Payload Content type application/json Copy Expand all Collapse all `{ "customerReferenceId": "Customer Reference information free text", "description": "Please proceed with deinstallation.", "details": [ { "assetId": "4-1234567890", "proceedWithLiveTraffic": false, "patchEquipment": { "cabinetId": "CH3:01:123456:0000", "details": "patch cable for this port", "port": 12 } } ], "removalDate": "2022-11-23", "purchaseOrder": { "type": "NEW", "number": "1111111111", "amount": 10000, "startDate": "2020-03-04", "endDate": "2021-03-04", "attachmentId": "85d9660a-f877-405a-b38e-8e61a4f77f44" }, "attachments": [ { "id": "85d9660a-f877-405a-b38e-8e61a4f77f44", "name": "additionalattachment.docx" } ], "contacts": [ { "type": "TECHNICAL", "firstName": "john", "lastName": "doe", "availability": "ANYTIME", "timezone": "Atlantic/Canary", "details": [ { "value": "+1234567890", "type": "PHONE" }, { "value": "+1234567890", "type": "MOBILE" } ] }, { "registeredUsers": [ "johndoe@acme.com", "janedoe@acme.com" ], "type": "NOTIFICATION", "availability": "ANYTIME", "timezone": "Atlantic/Canary" } ] }` ### Response samples * 400 * 403 * 500 Content type application/json Copy Expand all Collapse all `[ { "errorCode": "EQ-2012010", "errorMessage": "One or more properties are invalid", "correlationId": "99740129126918" } ]` Was this page helpful?YesNo Company * [About](https://equinix.com/company/) * [Community](https://community.equinix.com) * [Terms of Use](https://equinix.com/company/legal/terms/) Follow Us * [LinkedIn](https://linkedin.com/company/equinix/) * [YouTube](https://www.youtube.com/equinix) For AI Agents * [AGENTS.md 🤖](https://docs.equinix.com/AGENTS.md) Copyright © 2026 Equinix, Inc.