Skip to content

Latest commit

 

History

History
430 lines (276 loc) · 17.1 KB

RoutingProtocolsApi.md

File metadata and controls

430 lines (276 loc) · 17.1 KB
Raw

{{classname}}

All URIs are relative to https://api.equinix.com

Method HTTP request Description
CreateConnectionRoutingProtocol Post /fabric/v4/connections/{connectionId}/routingProtocols Create Protocol
CreateConnectionRoutingProtocolsInBulk Post /fabric/v4/connections/{connectionId}/routingProtocols/bulk Bulk Create Protocol
DeleteConnectionRoutingProtocolByUuid Delete /fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId} Delete Protocol
GetConnectionRoutingProtocolAllBgpActions Get /fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}/actions Get BGP Actions
GetConnectionRoutingProtocolByUuid Get /fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId} Get Protocol
GetConnectionRoutingProtocols Get /fabric/v4/connections/{connectionId}/routingProtocols GetRoutingProtocols
GetConnectionRoutingProtocolsBgpActionByUuid Get /fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}/actions/{actionId} Get BGP Action
GetConnectionRoutingProtocolsChangeByUuid Get /fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}/changes/{changeId} Get Change By ID
GetConnectionRoutingProtocolsChanges Get /fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}/changes Get Changes
PatchConnectionRoutingProtocolByUuid Patch /fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId} Patch Protocol
PostConnectionRoutingProtocolBgpActionByUuid Post /fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}/actions Clear/Reset BGP
ReplaceConnectionRoutingProtocolByUuid Put /fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId} Replace Protocol
ValidateRoutingProtocol Post /fabric/v4/routers/{routerId}/validate Validate Subnet

CreateConnectionRoutingProtocol

RoutingProtocolData CreateConnectionRoutingProtocol(ctx, body, connectionId) Create Protocol

This API provides capability to create Routing Protocol for connections

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body RoutingProtocolBase
connectionId string Connection Id

Return type

RoutingProtocolData

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateConnectionRoutingProtocolsInBulk

GetResponse CreateConnectionRoutingProtocolsInBulk(ctx, body, connectionId) Bulk Create Protocol

This API provides capability to create Routing Protocol for connections

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body ConnectionRoutingProtocolPostRequest
connectionId string Connection Id

Return type

GetResponse

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteConnectionRoutingProtocolByUuid

RoutingProtocolData DeleteConnectionRoutingProtocolByUuid(ctx, routingProtocolId, connectionId) Delete Protocol

This API provides capability to delete Routing Protocols on virtual connection

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
routingProtocolId string Routing Protocol Id
connectionId string Connection Id

Return type

RoutingProtocolData

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetConnectionRoutingProtocolAllBgpActions

BgpActionsBulkData GetConnectionRoutingProtocolAllBgpActions(ctx, routingProtocolId, connectionId, optional) Get BGP Actions

This API provides capability to get all BGP actions status

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
routingProtocolId string Routing Protocol Id
connectionId string Connection Id
optional *RoutingProtocolsApiGetConnectionRoutingProtocolAllBgpActionsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a RoutingProtocolsApiGetConnectionRoutingProtocolAllBgpActionsOpts struct

Name Type Description Notes

offset | optional.Int32| offset | limit | optional.Int32| number of records to fetch |

Return type

BgpActionsBulkData

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetConnectionRoutingProtocolByUuid

RoutingProtocolData GetConnectionRoutingProtocolByUuid(ctx, routingProtocolId, connectionId) Get Protocol

This API provides capability to accept/reject user's virtual connection

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
routingProtocolId string Routing Protocol Id
connectionId string Connection Id

Return type

RoutingProtocolData

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetConnectionRoutingProtocols

GetResponse GetConnectionRoutingProtocols(ctx, connectionId, optional) GetRoutingProtocols

This API provides capability to get Routing Protocols for connections

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
connectionId string Connection Id
optional *RoutingProtocolsApiGetConnectionRoutingProtocolsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a RoutingProtocolsApiGetConnectionRoutingProtocolsOpts struct

Name Type Description Notes

offset | optional.Int32| offset | limit | optional.Int32| number of records to fetch |

Return type

GetResponse

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetConnectionRoutingProtocolsBgpActionByUuid

BgpActionData GetConnectionRoutingProtocolsBgpActionByUuid(ctx, connectionId, routingProtocolId, actionId) Get BGP Action

This API provides capability to retrieve specific BGP action

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
connectionId string Connection Id
routingProtocolId string Routing Protocol Id
actionId string BGP Action UUID

Return type

BgpActionData

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetConnectionRoutingProtocolsChangeByUuid

RoutingProtocolChangeData GetConnectionRoutingProtocolsChangeByUuid(ctx, connectionId, routingProtocolId, changeId) Get Change By ID

This API provides capability to retrieve specific Routing Protocol Change

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
connectionId string Connection Id
routingProtocolId string Routing Protocol Id
changeId string Routing Protocol Change UUID

Return type

RoutingProtocolChangeData

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetConnectionRoutingProtocolsChanges

RoutingProtocolChangeDataResponse GetConnectionRoutingProtocolsChanges(ctx, connectionId, routingProtocolId, optional) Get Changes

This API provides capability to retrieve user's Routing Protocol Changes

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
connectionId string Connection Id
routingProtocolId string Routing Protocol Id
optional *RoutingProtocolsApiGetConnectionRoutingProtocolsChangesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a RoutingProtocolsApiGetConnectionRoutingProtocolsChangesOpts struct

Name Type Description Notes

offset | optional.Int32| offset | limit | optional.Int32| number of records to fetch |

Return type

RoutingProtocolChangeDataResponse

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchConnectionRoutingProtocolByUuid

RoutingProtocolData PatchConnectionRoutingProtocolByUuid(ctx, body, routingProtocolId, connectionId) Patch Protocol

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body []ConnectionChangeOperation
routingProtocolId string Routing Protocol Id
connectionId string Connection Id

Return type

RoutingProtocolData

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostConnectionRoutingProtocolBgpActionByUuid

BgpActionData PostConnectionRoutingProtocolBgpActionByUuid(ctx, body, routingProtocolId, connectionId) Clear/Reset BGP

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body BgpActionRequest
routingProtocolId string Routing Protocol Id
connectionId string Connection Id

Return type

BgpActionData

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReplaceConnectionRoutingProtocolByUuid

RoutingProtocolData ReplaceConnectionRoutingProtocolByUuid(ctx, body, routingProtocolId, connectionId) Replace Protocol

This API provides capability to replace complete Routing Protocols on a virtual connection

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body RoutingProtocolBase
routingProtocolId string Routing Protocol Id
connectionId string Connection Id

Return type

RoutingProtocolData

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ValidateRoutingProtocol

ValidateSubnetResponse ValidateRoutingProtocol(ctx, body, routerId) Validate Subnet

This API provides capability to validate all subnets associated with any connection in the given FCR

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body ValidateRequest
routerId string Cloud Router UUID

Return type

ValidateSubnetResponse

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]