Skip to content

Latest commit

 

History

History
298 lines (191 loc) · 11.5 KB

RouteFilterRulesApi.md

File metadata and controls

298 lines (191 loc) · 11.5 KB
Raw

{{classname}}

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

Method HTTP request Description
CreateRouteFilterRule Post /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules Create RFRule
CreateRouteFilterRulesInBulk Post /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/bulk Bulk RFRules
DeleteRouteFilterRuleByUuid Delete /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/{routeFilterRuleId} DeleteRFRule
GetRouteFilterRuleByUuid Get /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/{routeFilterRuleId} GetRFRule By UUID
GetRouteFilterRuleChangeByUuid Get /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/{routeFilterRuleId}/changes/{changeId} Get Change By ID
GetRouteFilterRuleChanges Get /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/{routeFilterRuleId}/changes Get All Changes
GetRouteFilterRules Get /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules GetRFRules
PatchRouteFilterRuleByUuid Patch /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/{routeFilterRuleId} PatchRFilterRule
ReplaceRouteFilterRuleByUuid Put /fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/{routeFilterRuleId} ReplaceRFRule

CreateRouteFilterRule

RouteFilterRulesData CreateRouteFilterRule(ctx, body, routeFilterId) Create RFRule

This API provides capability to create a Route Filter Rule

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body RouteFilterRulesBase
routeFilterId string Route Filters Id

Return type

RouteFilterRulesData

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]

CreateRouteFilterRulesInBulk

GetRouteFilterRulesResponse CreateRouteFilterRulesInBulk(ctx, body, routeFilterId) Bulk RFRules

This API provides capability to create bulk route filter rules

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body RouteFilterRulesPostRequest
routeFilterId string Route Filters Id

Return type

GetRouteFilterRulesResponse

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]

DeleteRouteFilterRuleByUuid

RouteFilterRulesData DeleteRouteFilterRuleByUuid(ctx, routeFilterId, routeFilterRuleId) DeleteRFRule

This API provides capability to delete a Route Filter Rule

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
routeFilterId string Route Filters Id
routeFilterRuleId string Route Filter Rules Id

Return type

RouteFilterRulesData

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]

GetRouteFilterRuleByUuid

RouteFilterRulesData GetRouteFilterRuleByUuid(ctx, routeFilterId, routeFilterRuleId) GetRFRule By UUID

This API provides capability to view a Route Filter Rule by UUID

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
routeFilterId string Route Filters Id
routeFilterRuleId string Route Filter Rules Id

Return type

RouteFilterRulesData

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]

GetRouteFilterRuleChangeByUuid

RouteFilterRulesChangeData GetRouteFilterRuleChangeByUuid(ctx, routeFilterId, routeFilterRuleId, changeId) Get Change By ID

This API provides capability to retrieve a specific Route Filter Rule's Changes

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
routeFilterId string Route Filters Id
routeFilterRuleId string Route Filter Rules Id
changeId string Route Filter Rule Change UUID

Return type

RouteFilterRulesChangeData

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]

GetRouteFilterRuleChanges

RouteFilterRulesChangeDataResponse GetRouteFilterRuleChanges(ctx, routeFilterId, routeFilterRuleId, optional) Get All Changes

This API provides capability to retrieve all of a Route Filter Rule's Changes

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
routeFilterId string Route Filters Id
routeFilterRuleId string Route Filter Rules Id
optional *RouteFilterRulesApiGetRouteFilterRuleChangesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a RouteFilterRulesApiGetRouteFilterRuleChangesOpts struct

Name Type Description Notes

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

Return type

RouteFilterRulesChangeDataResponse

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]

GetRouteFilterRules

GetRouteFilterRulesResponse GetRouteFilterRules(ctx, routeFilterId, optional) GetRFRules

This API provides capability to get all Route Filters Rules for Fabric

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
routeFilterId string Route Filters Id
optional *RouteFilterRulesApiGetRouteFilterRulesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a RouteFilterRulesApiGetRouteFilterRulesOpts struct

Name Type Description Notes

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

Return type

GetRouteFilterRulesResponse

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]

PatchRouteFilterRuleByUuid

RouteFilterRulesData PatchRouteFilterRuleByUuid(ctx, body, routeFilterId, routeFilterRuleId) PatchRFilterRule

This API provides capability to partially update a Route Filter Rule

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body []RouteFilterRulesPatchRequestItem
routeFilterId string Route Filters Id
routeFilterRuleId string Route Filter Rules Id

Return type

RouteFilterRulesData

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]

ReplaceRouteFilterRuleByUuid

RouteFilterRulesData ReplaceRouteFilterRuleByUuid(ctx, body, routeFilterId, routeFilterRuleId) ReplaceRFRule

This API provides capability to replace a Route Filter Rule completely

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body RouteFilterRulesBase
routeFilterId string Route Filters Id
routeFilterRuleId string Route Filter Rules Id

Return type

RouteFilterRulesData

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]