Cross Connect (2.0)
Download OpenAPI specification:Download
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.
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:
Request Body schema: application/json
| customerReferenceId | string [ 1 .. 40 ] characters Customer Reference Identifier / External Reference Identifier | ||||||||||||
Array of objects (Attachment_Request) <= 5 items File(s) attached to the Cross Connect | |||||||||||||
Array (<= 5 items)
| |||||||||||||
| description | string [ 0 .. 4000 ] characters Description of Cross Connect | ||||||||||||
| expediteDateTime | string <date-time> Expedite orders are delivered within the next 2 - 24 hours. Value must be in ISO-8601 UTC timezone format. | ||||||||||||
required | Array of objects (Layer1_Details) [ 1 .. 10 ] items Cross connections details | ||||||||||||
Array ([ 1 .. 10 ] items)
| |||||||||||||
object (purchaseOrder) Purchase Order | |||||||||||||
| |||||||||||||
Array of ContactRequestRegisteredUser (object) or ContactRequestNonRegisteredUser (object) | |||||||||||||
Array Any of
| |||||||||||||
Responses
| Location | string Example: "/orders/1-23232322" Location on newly created layer |
Request samples
- Payload
{- "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
[- {
- "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"
}
]
}
]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:
path Parameters
| orderId required | string [ 1 .. 100 ] characters Identifier of the cross connect order |
Request Body schema: application/jsonrequired
The cross connect to be updated
Array of objects (ContactRequestRegisteredUser_Update) <= 1 items | |||||
Array (<= 1 items)
| |||||
Responses
Request samples
- Payload
{- "contacts": [
- {
- "registeredUsers": [
- "john_doe"
], - "type": "NOTIFICATION"
}
]
}Response samples
- 400
- 403
- 500
[- {
- "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"
}
]
}
]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:
Request Body schema: application/json
| customerReferenceId | string [ 1 .. 40 ] characters Customer Reference Identifier / External Reference Identifier | ||||||||||||
object (purchaseOrder) Purchase Order | |||||||||||||
| |||||||||||||
Array of ContactRequestRegisteredUser (object) or ContactRequestNonRegisteredUser (object) | |||||||||||||
Array Any of
| |||||||||||||
Array of objects (Attachment_Request) <= 5 items File(s) attached to the layer #1 connections | |||||||||||||
Array (<= 5 items)
| |||||||||||||
| description | string [ 0 .. 4000 ] characters Description of deinstallation | ||||||||||||
required | Array of objects (Layer1_Deinstall_Details) [ 1 .. 10 ] items layer #1 connections details | ||||||||||||
Array ([ 1 .. 10 ] items)
| |||||||||||||
| removalDate required | string <date> Equinix will aim to terminate this Cross Connect at this date subjected to operation availability. | ||||||||||||
Responses
| Location | string Example: "/orders/1-23232322" Location on newly created deinstall request |
Request samples
- Payload
{- "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
[- {
- "errorCode": "EQ-2012010",
- "errorMessage": "One or more properties are invalid",
- "correlationId": "99740129126918"
}
]