Equinix Fabric API v4 | Equinix Product Documentation

Get Optical Metro Connect Service

Request

Get a single Optical Metro Connect by UUID.

Security

BearerAuth

Path

opticalConnectIdstring, (uuid)required

Unique identifier of an Optical Connect.

Example:557400f8-d360-11e9-bb65-2a2ae2dbcce4

Payload

// No request payload

Responses

Successful Operation

Bodyapplication/json

hrefstring, (uri)read-only

URI of this Optical Connect resource.

Example:"https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0"

uuidstring, (uuid)read-only

Unique identifier of this Optical Connect.

Example:"06dbb0e3-e55d-4090-8aff-fc5654abaad0"

typestring

Connection Type.
OC - Optical Connect.

Value:"OC"

Example:"OC"

namestringread-only

Equinix-assigned name, derived from the account number and the two IBX locations.

Example:"123456-SV1-SV2-01"

statestring(OpticalConnectState)read-only

Optical Connect lifecycle states.

Enum:"PROVISIONING""PROVISIONED""PROVISIONING_FAILED""REPROVISIONING""REPROVISIONING_FAILED""DEPROVISIONING""DEPROVISIONED"

Example:"PROVISIONED"

bandwidthinteger

Provisioned connection bandwidth in Mbps.

Example:10000

connectionDestinationTypestring

Where the Z-side terminates.
COLO - your own colocation space at another Equinix IBX.
BMMR - a Building Meet-Me Room.
REMOTE - another customer's colocation space at another Equinix IBX.

Enum:"COLO""BMMR""REMOTE"

pathTypestring

Level of resilience for the connection.
UNPROTECTED - a single fiber path with no node redundancy.
PROTECTED - two diverse fiber paths between single nodes at each IBX.
DUAL_DIVERSE - two diverse fiber paths terminating on redundant nodes at both IBXs.

Enum:"DUAL_DIVERSE""PROTECTED""UNPROTECTED"

bmmrTypestring

BMMR infrastructure ownership type.
EQUINIX - Equinix-operated.
SELF - customer-operated.
Required only when connectionDestinationType is BMMR.

Enum:"EQUINIX""SELF"

redundancyobject(OpticalConnectRedundancy)

Optical Connect redundancy configuration.
Required only for DUAL_DIVERSE connection.

aSideobject(OpticalConnectASideResponse)

Originating end as provisioned, with the demarcation point and IBX location.

zSideobject(OpticalConnectZSideResponse)

Terminating end as provisioned, with the demarcation point and IBX location.

orderobject(OpticalConnectOrder)

Ordering and billing reference details for this connection.

accountobject(SimplifiedAccount)

notificationsArray of objects(OpticalConnectNotification)

Preferences for notifications on connection configuration or status changes

changeLogobject(Changelog)

Change log

Response

{
  "href": "https://api.equinix.com/fabric/v4/opticalConnects/06dbb0e3-e55d-4090-8aff-fc5654abaad0",
  "uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0",
  "type": "OC",
  "name": "270848-SV1-SV2-01",
  "state": "PROVISIONING",
  "bandwidth": 100000,
  "connectionDestinationType": "COLO",
  "pathType": "UNPROTECTED",
  "aSide": {
    "demarcationPoint": { … },
    "location": { … }
  },
  "zSide": {
    "demarcationPoint": { … },
    "location": { … }
  },
  "order": {
    "purchaseOrderNumber": "156576",
    "orderNumber": "1-129105284100"
  },
  "account": {
    "accountNumber": 270848,
    "orgId": 123
  },
  "notifications": [
    { … }
  ],
  "changeLog": {
    "createdByEmail": "abc@xyz.com",
    "createdDateTime": "2025-07-24T06:50:46Z",
    "updatedByEmail": "abc@xyz.com",
    "updatedDateTime": "2025-07-24T06:51:46Z"
  }
}