Equinix Fabric API v4 | Equinix Product Documentation

Clear/Reset BGP

Request

This API provides capability to clear/reset Routing Protocols BGP session

Security

BearerAuth

Path

routingProtocolIdstring, (uuid)required

Routing Protocol Id

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

connectionIdstringrequired

Connection Id

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

Bodyapplication/jsonrequired

typestring(BGPActions)required

BGP action type

Enum:"CLEAR_BGPIPV4""CLEAR_BGPIPV6""CLEAR_BGPIPV4_INBOUND""CLEAR_BGPIPV6_INBOUND""RESET_BGPIPV4""RESET_BGPIPV6"

Payload

{
  "type": "CLEAR_BGPIPV4"
}

Responses

Successful operation

Bodyapplication/json

hrefstring, (uri)

Routing Protocol URI

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

uuidstring, (uuid)

Routing protocol identifier

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

typestring(BGPActions)

BGP action type

Enum:"CLEAR_BGPIPV4""CLEAR_BGPIPV6""CLEAR_BGPIPV4_INBOUND""CLEAR_BGPIPV6_INBOUND""RESET_BGPIPV4""RESET_BGPIPV6"

descriptionstring

BGP action description

statestring(BGPActionStates)

BGP action state

Enum:"PENDING""FAILED""SUCCEEDED"

changelogobject(Changelog)

Change log

Response

{
  "href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/3f5ed98a-8dba-4651-a317-8ad0234dd157/actions/123ed98a-92ba-9951-bb17-17d0234dd096",
  "uuid": "123ed98a-92ba-9951-bb17-17d0234dd096",
  "type": "RESET_BGPIPV4",
  "description": "hard reset bgp ipv4 session",
  "state": "PENDING",
  "changelog": {
    "createdBy": "adminuser",
    "createdDateTime": "2020-05-21T10:30:00Z"
  }
}