Equinix Fabric API v4 | Equinix Product Documentation

Patch Protocol

Request

This API provides capability to partially update Routing Protocols on a virtual connection

Security

BearerAuth

Path

routingProtocolIdstring, (uuid)required

Routing Protocol Id

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

connectionIdstringrequired

Connection Id

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

Body

required

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": "/bgpIpv4/enabled",
    "value": true
  }
]

Responses

Successful operation

Bodyapplication/json

One of:

typestring

Routing protocol type

Value:"BGP"

namestring

Example:"My-BGP-route-1"

bgpIpv4object(BGPConnectionIpv4)

bgpIpv6object(BGPConnectionIpv6)

customerAsninteger, (int64)

Customer asn

Example:65002

equinixAsninteger, (int64)

Equinix asn

Example:65002

bgpAuthKeystring

BGP authorization key

Example:"testAuthKey"

asOverrideEnabledboolean

Enable AS number override

bfdobject(RoutingProtocolBFD)

hrefstring, (uri)

Routing Protocol URI

Example:"https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/69762051-85ed-4d13-b6b4-e32e93c672b5"

uuidstring, (uuid)

Routing protocol identifier

Example:"c9b8e7a2-f3b1-4576-a4a9-1366a63df170"

statestring

Enum:"PROVISIONED""DEPROVISIONED""PROVISIONING""DEPROVISIONING""REPROVISIONING""FAILED"

operationobject(RoutingProtocolOperation)

changeobject(RoutingProtocolChange)

Current state of latest Routing Protocol change

changelogobject(Changelog)

Change log

projectobject(RoutingProtocolProject)

The Routing Protocol's project

connectionobject(RoutingProtocolConnection)

Connection specification

Response

{
  "href": "https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4",
  "uuid": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
  "state": "REPROVISIONING",
  "change": {
    "uuid": "3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
    "href": "https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
    "type": "ROUTING_PROTOCOL_UPDATE"
  },
  "changelog": {
    "createdBy": "fabric",
    "createdDateTime": "2021-10-30T07:21:39Z",
    "updatedBy": "fabric",
    "updatedDateTime": "2021-10-30T07:21:39Z"
  },
  "type": "BGP",
  "bgpIpv4": {
    "enabled": true,
    "customerPeerIp": "10.1.1.3",
    "outboundASPrependCount": 3,
    "operation": { … }
  },
  "customerAsn": 10000,
  "equinixAsn": 10001
}