Equinix Routing Protocols API

Routing Protocols

Documentation Provider Profile APIs.io OpenAPI GitHub

Equinix Routing Protocols API is one of 74 APIs that Equinix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Routing Protocols. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 13 operations across 8 paths, and defines 41 schemas. It is described by OpenAPI 3.0.1, at version 1.2.

Requests are made against a single base URL, https://api.equinix.com.

13 operations 8 paths 41 schemas 1 DELETE6 GET1 PATCH4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.1

API Version

1.2

Base URL

https://api.equinix.com

Contact

Equinix API Support

View terms

Resource Areas

Paths & Operations 13

Across 8 paths, the API surfaces 13 operations — 1 DELETE, 6 GET, 1 PATCH, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Routing Protocols 13

Routing Protocols

GET

/fabric/v4/connections/{connectionId}/routingProtocols

GetRoutingProtocols

getConnectionRoutingProtocols 3 params → 200400401403404500

POST

/fabric/v4/connections/{connectionId}/routingProtocols

Create Protocol

createConnectionRoutingProtocol 1 param body → 202400401403404415500

POST

/fabric/v4/connections/{connectionId}/routingProtocols/bulk

Bulk Create Protocol

createConnectionRoutingProtocolsInBulk 1 param body → 202400401403404415500

GET

/fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}

Get Protocol

getConnectionRoutingProtocolByUuid 2 params → 200400401403404415500

PUT

/fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}

Replace Protocol

replaceConnectionRoutingProtocolByUuid 2 params body → 202400401403404415500

DELETE

/fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}

Delete Protocol

deleteConnectionRoutingProtocolByUuid 2 params → 202400401403404415500

PATCH

/fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}

Patch Protocol

patchConnectionRoutingProtocolByUuid 2 params body → 202400401403404415500

GET

/fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}/actions

Get BGP Actions

getConnectionRoutingProtocolAllBgpActions 4 params → 200400401403404415500

POST

/fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}/actions

Clear/Reset BGP

postConnectionRoutingProtocolBgpActionByUuid 2 params body → 202400401403404415500

GET

/fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}/actions/{actionId}

Get BGP Action

getConnectionRoutingProtocolsBgpActionByUuid 3 params → 200400401403404500

GET

/fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}/changes/{changeId}

Get Change By ID

getConnectionRoutingProtocolsChangeByUuid 3 params → 200400401403404500

GET

/fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}/changes

Get Changes

getConnectionRoutingProtocolsChanges 4 params → 200400401403404500

POST

/fabric/v4/routers/{routerId}/validate

Validate Subnet

validateRoutingProtocol 1 param body → 200400

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are RoutingProtocolBGPData (15 properties), Changelog (12 properties), RoutingProtocolDirectData (10 properties), BGPConnectionIpv6 (8 properties). Each schema is shown below with its type and property counts.

ValidateRequest_filter

object

Filters

1 property

RoutingProtocolDirectData

object

10 properties

BGPActionStates

string

BGP action state

BGPConnectionOperation

object

BGP IPv4 or IPv6 Connection State operational data

2 properties

ConnectionChangeOperation

object

Connection change operation data

3 properties 3 required

BGPActionData

object

6 properties

ValidateRequest

object

Validate connection auth api key or vlan

1 property

ConnectionRoutingProtocolPatchRequest

array

Patch connection routing protocol request

RoutingProtocolDirectType

object

4 properties 1 required

ActionId

string

BGP Action UUID

ValidateRequest_filter_and

object

3 properties

GetResponse

object

2 properties

Changelog

object

Change log

12 properties

BGPActionRequest

object

BGP action request

1 property 1 required

ConnectionSideAdditionalInfo

object

Additional information

2 properties

RoutingProtocolChange

object

Current state of latest Routing Protocol change

3 properties 2 required

RoutingProtocolBase

object

1 property

BGPActions

string

BGP action type

RoutingProtocolChangeOperation

object

Routing Protocol change operation data

3 properties 3 required

ConnectionRoutingProtocolPostRequest

object

Create connection routing protocolpost request

1 property

BGPActionsBulkData

object

List of BGP Actions

2 properties

RoutingProtocolBGPType

object

8 properties 1 required

RoutingProtocolOperation

object

1 property

Pagination

object

Pagination response information

5 properties 2 required

RoutingProtocolData

object

1 property

RoutingProtocolChangeDataResponse

object

List of network changes

2 properties

ConnectionId

string

Connection UUID

ChangeId

string

Routing Protocol Change UUID

BGPConnectionIpv4

object

8 properties 2 required

RoutingProtocolBGPData

object

15 properties

DirectConnectionIpv6

object

1 property 1 required

BGPConnectionIpv6

object

8 properties 2 required

RouterId

string

Cloud Router UUID

PriceError_additionalInfo

object

2 properties

RoutingProtocolChangeData

object

Current state of latest Routing Protocol change

7 properties

ErrorList

array

List of Error Message

RoutingProtocolBFD

object

2 properties 1 required

ValidateSubnetResponse

object

ValidateResponse

1 property

DirectConnectionIpv4

object

1 property

Error

object

Error Response with details

6 properties 2 required

RoutingProtocolId

string

Routing Protocol UUID

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Equinix publishes across the network.

Equinix Agent Templates API

AE Profile APIs.io

Equinix Agents API

AE Profile APIs.io

Equinix Authentication API

AE Profile APIs.io

Equinix availability API

AE Profile APIs.io

Equinix Batches API

AE Profile APIs.io

Equinix BGP API

AE Profile APIs.io

Equinix Capacity API

AE Profile APIs.io

Equinix Cloud Events API

AE Profile APIs.io

Equinix Cloud Routers API

AE Profile APIs.io

Equinix Company Profiles API

AE Profile APIs.io

Equinix Connections API

AE Profile APIs.io

Equinix Console Log Details API

AE Profile APIs.io

#Routing Protocols

← Back to E APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Equinix Routing Protocols API

Metadata

Paths & Operations 13

Schemas 41

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Equinix Routing Protocols API

Metadata

Paths & Operations 13

Schemas 41

Specification

Source

More from Equinix 12

API Details

Provider

Explore more