Equinix Fabric API v4 | Equinix Product Documentation

Connections

Operations

Create Connection

Request

This API provides capability to create user's virtual connection

Security

BearerAuth

Query

dryRunboolean

option to verify that API calls will succeed

Default:false

Bodyapplication/jsonrequired

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"

namestringrequired

Customer-provided connection name

orderobject(Order)

notificationsArray of objects(SimplifiedNotification)required

Preferences for notifications on connection configuration or status changes

bandwidthinteger, [ 0 .. 100000 ]required

Connection bandwidth in Mbps

geoScopestring(GeoScopeType)

Geographic boundary for the connection

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

redundancyobject(ConnectionRedundancy)

Connection redundancy configuration

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

projectobject(Project)

additionalInfoArray of objects(ConnectionSideAdditionalInfo)

Connection additional information

marketplaceSubscriptionobject(marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

Payload

{
  "type": "EVPL_VC",
  "name": "My-Port-2-Port-Connection-1",
  "bandwidth": 1000,
  "order": {
    "purchaseOrderNumber": "po1234",
    "termLength": 1
  },
  "aSide": {
    "accessPoint": { … }
  },
  "zSide": {
    "accessPoint": { … }
  },
  "project": {
    "projectId": "ac4d34ca-0d9c-4bc2-9aab-1234567abcde"
  },
  "notifications": [
    { … }
  ]
}

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

{
  "type": "EVPL_VC",
  "name": "Colo to AWS Connection",
  "bandwidth": 50,
  "redundancy": {
    "priority": "PRIMARY"
  },
  "aSide": {
    "accessPoint": { … }
  },
  "zSide": {
    "accessPoint": { … }
  },
  "project": {
    "projectId": "a347a370-39b5-427f-c330-7471a9abd9"
  },
  "order": {
    "purchaseOrderNumber": "1-129105284100"
  },
  "notifications": [
    { … }
  ]
}