Equinix Fabric API v4 | Equinix Product Documentation

Update Connection by ID

Request

Update Connection by ID

Security

BearerAuth

Path

connectionIdstringrequired

Connection Id

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

Query

dryRunboolean

option to verify that API calls will succeed

Default:false

Bodyapplication/json-patch+jsonrequired

Array [

opstringrequired

Handy shortcut for operation name

Example:"add"

pathstringrequired

path inside document leading to updated parameter

Example:"/ipv6"

valueanyrequired

new value for updated parameter

]

Payload

[
  {
    "op": "replace",
    "path": "/name",
    "value": "Conn-Name-2"
  }
]

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/3a58dd05-f46d-4b1d-a154-2e85c396ea62",
  "type": "EVPL_VC",
  "uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",
  "name": "My-Layer2-Connection-2",
  "bandwidth": 1000,
  "direction": "OUTGOING",
  "isRemote": true,
  "redundancy": {
    "group": "66c10a60-789e-4b25-b85c-7eb225a4c344",
    "priority": "PRIMARY"
  },
  "aSide": {
    "accessPoint": { … }
  },
  "zSide": {
    "accessPoint": { … }
  },
  "operation": {
    "providerStatus": "PROVISIONED",
    "equinixStatus": "PROVISIONED"
  },
  "change": {
    "type": "CONNECTION_UPDATE",
    "status": "APPROVED",
    "createdDateTime": "2021-12-12T06:00:01.183Z",
    "data": { … }
  },
  "changeLog": {
    "createdDateTime": "2020-04-21T10:30:00Z"
  },
  "account": {
    "accountNumber": 270001,
    "orgId": 91997,
    "globalOrgId": "3453453cccc"
  }
}