Equinix Fabric API v4 | Equinix Product Documentation

Get Connection by ID

Request

The API provides capability to get user's virtual connection details (Service Tokens, Access Points, Link Protocols, etc) by it's connection ID (UUID)

Security

BearerAuth

Path

connectionIdstringrequired

Connection Id

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

Query

directionstring(ConnectionDirection)

Connection Direction

Enum:"INTERNAL""INCOMING""OUTGOING"

Payload

// No request payload

Responses

Successful operation

Bodyapplication/json

hrefstring, (uri)read-only

Connection URI

typestring(ConnectionType)required

Connection type

Enum:"EVPL_VC""EPL_VC""EC_VC""IP_VC""ACCESS_EPL_VC""EIA_VC""EVPLAN_VC""EPLAN_VC""EVPTREE_VC""EPTREE_VC"

uuidstring

Equinix-assigned connection identifier

namestringrequired

Customer-provided connection name

descriptionstring

Customer-provided connection description

changeobject(Change)

Current state of latest connection change

operationobject(ConnectionOperation)

Connection type-specific operational data

orderobject(Order)

notificationsArray of objects(SimplifiedNotification)

Preferences for notifications on connection configuration or status changes

accountobject(SimplifiedAccount)

changeLogobject(Changelog)

Change log

bandwidthinteger, [ 0 .. 10000 ]required

Connection bandwidth in Mbps

geoScopestring(GeoScopeType)

Geographic boundary for this connection

Enum:"CANADA""CONUS""JAPAN""UK""AUSTRALIA""BRAZIL""SWITZERLAND""EU"

redundancyobject(ConnectionRedundancy)

Connection redundancy configuration

isRemoteboolean

Connection property derived from access point locations

directionstring(ConnectionDirection)

Connection directionality from the requester point of view

Enum:"INTERNAL""INCOMING""OUTGOING"

aSideobject(ConnectionSide)required

Connection configuration object for each side of multi-segment connection

zSideobject(ConnectionSide)required

Connection configuration object for each side of multi-segment connection

marketplaceSubscriptionobject(marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

additionalInfoArray of objects(ConnectionSideAdditionalInfo)

Connection additional information

projectobject(Project)

Project is optional for AM-CRH customers. If not provided, a default project will be assigned.

Example:"30ad25e2-53dc-11ed-bdc3-0242ac120002"

Response

{
  "href": "https://api.equinix.com/fabric/v4/connections/462ad0bb-7fe2-41b1-8d1a-c62494e0c7e3",
  "type": "EVPL_VC",
  "uuid": "462ad0bb-7fe2-41b1-8d1a-c62494e0c7e3",
  "name": "E2E-CON-280122031843987",
  "state": "DEPROVISIONED",
  "operation": {
    "providerStatus": "FAILED",
    "equinixStatus": "DEPROVISIONED"
  },
  "order": {
    "purchaseOrderNumber": "PO608540135268"
  },
  "notifications": [
    { … }
  ],
  "account": {
    "accountNumber": 270001,
    "orgId": 91997,
    "globalOrgId": "0016u000003JZ4sAAG"
  },
  "changeLog": {
    "createdBy": "testBuyer",
    "createdDateTime": "2022-01-28T03:18:48.908Z"
  },
  "bandwidth": 50,
  "redundancy": {
    "group": "50ba51bb-085d-4084-ac38-c31860ca5f4d",
    "priority": "PRIMARY"
  },
  "isRemote": false,
  "direction": "OUTGOING",
  "aSide": {
    "accessPoint": { … }
  },
  "zSide": {
    "accessPoint": { … }
  }
}