Skip to main content
Loading...

API docs by

Create Cross Connect

Request

The API provides capability to create a new Cross Connect.

Security
BearerAuth
Bodyapplication/jsonrequired
typestring(CrossConnectType)required

Type of Cross Connect.

Value:"XC"
Example:"XC"
namestring, [ 3 .. 50 ] charactersrequired

A short, descriptive name for this Cross Connect.

Example:"My-CC-service"
bmmrTypestring(BmmrType)

Required when connecting to a BMMR.
Use EQUINIX when BMMR Extension is required and Equinix installs it, or SELF when you install it yourself.

Enum:"EQUINIX""SELF"
Example:"EQUINIX"
circuitIdstring

Circuit identifier of the Cross Connect.

redundancyobject(CrossConnectRedundancy)

Provide it to place a diverse Cross Connect against an existing one - set group to the redundancy group id or the serial number of the existing Cross Connect, and priority to SECONDARY.

aSideobject(CrossConnectASideRequest)required

A-Side connection details.

zSideobject(CrossConnectZSideRequest)required

Z-Side connection details.
Provide the DemarcationPoint, the LOA reference or the BMMR location depending on the Cross Connect being requested.

scheduleobject(ScheduleRequest)

Preferred installation schedule. When omitted, the Cross Connect is scheduled with the STANDARD schedule code.

servicesArray of objects(CrossConnectServiceRequest)

Cross Connect Services.

notificationsArray of objects(CrossConnectNotification)

Preferences for notifications on Cross Connect configuration or status changes.

orderobject(OrderRequest)

Cross Connect Order.

notesArray of objects, <= 1 items(CrossConnectNoteRequest)

Additional Note.

attachmentsArray of objects, <= 5 items(CrossConnectAttachment)

Additional Attachments.

Payload

Minimal Cross Connect request with only the required fields.

{
  "type": "XC",
  "name": "My-CC-service",
  "aSide": {
    "demarcationPoint": { … }
  },
  "zSide": {
    "demarcationPoint": { … }
  },
  "schedule": {
    "code": "STANDARD",
    "requestedDateTime": "2026-02-27T07:21:39Z"
  }
}

Responses

Accepted.

Bodyapplication/json
hrefstring, (uri)

Cross Connect URI.

Example:"https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743"
typestring(CrossConnectType)

Type of Cross Connect.

Value:"XC"
Example:"XC"
uuidstring, (uuid)

Cross Connect Identifier.

Example:"46bb1a31-c28f-4197-8b10-06e0e03d0743"
namestring

A short, descriptive name for this Cross Connect.

Example:"My-CC-service"
statestring(CrossConnectState)

Cross Connect State.

Enum:"PENDING""PENDING_ACTION""PROVISIONING""PROVISIONED""DEPROVISIONING""DEPROVISIONED""CANCELLING""CANCELLED""FAILED"
Example:"PENDING"
allowedActionsArray of objectsread-only

List of actions that can be performed on the Cross Connect based on its current state. Use these values to determine which action types are valid to submit to the actions endpoint.

bmmrTypestring(BmmrType)

Cross Connect BMMR Type.

Enum:"EQUINIX""SELF"
Example:"EQUINIX"
mediaTypestring

Media type of the Cross Connect.

Example:"SINGLE_MODE_FIBER"
mediaSubTypestring

Media sub-type of the Cross Connect.

Example:"SINGLE_MODE_FIBER"
circuitIdstring

Circuit identifier of the Cross Connect.

serialNumberstringread-only

Serial number of the Cross Connect.

Example:"234567890"
redundancyobject(CrossConnectRedundancy)

Cross Connect Redundancy.

aSideobject(CrossConnectASideResponse)

A-Side connection details.

zSideobject(CrossConnectZSideResponse)

Z-Side connection details.

accountobject(CrossConnectAccount)

Account the Cross Connect belongs to.

notificationsArray of objects(CrossConnectNotification)

Preferences for notifications on Cross Connect configuration or status changes.

orderobject(OrderResponse)

Cross Connect Order.

changeLogobject(CrossConnectChangelog)

Cross Connect Change Log.

Response
{
  "href": "https://api.equinix.com/fabric/v4/crossConnects/46bb1a31-c28f-4197-8b10-06e0e03d0743",
  "type": "XC",
  "name": "My-CC-service",
  "uuid": "46bb1a31-c28f-4197-8b10-06e0e03d0743",
  "state": "PROVISIONING",
  "serialNumber": "234567890",
  "redundancy": {
    "group": "7cf39156-9dec-40f7-a254-9bb401342e83",
    "priority": "PRIMARY"
  },
  "aSide": {
    "demarcationPoint": { … },
    "location": { … }
  },
  "zSide": {
    "demarcationPoint": { … },
    "location": { … }
  },
  "account": {
    "accountNumber": 123456
  },
  "notifications": [
    { … },
    { … },
    { … }
  ],
  "order": {
    "orderNumber": "1-1234567890",
    "customerReferenceId": "12345"
  },
  "links": [
    { … },
    { … },
    { … },
    { … }
  ],
  "changeLog": {
    "createdDateTime": "2026-02-28T07:21:39Z",
    "createdBy": "testuser"
  }
}
Was this page helpful?