Skip to content

Latest commit

 

History

History
315 lines (199 loc) · 11.1 KB

CloudRoutersApi.md

File metadata and controls

315 lines (199 loc) · 11.1 KB

{{classname}}

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

Method HTTP request Description
CreateCloudRouter Post /fabric/v4/routers Create Routers
CreateCloudRouterAction Post /fabric/v4/routers/{routerId}/actions Route table actions
DeleteCloudRouterByUuid Delete /fabric/v4/routers/{routerId} Delete Routers
GetCloudRouterActions Get /fabric/v4/routers/{routerId}/actions Get actions
GetCloudRouterByUuid Get /fabric/v4/routers/{routerId} Get Routers
GetCloudRouterPackageByCode Get /fabric/v4/routerPackages/{routerPackageCode} Get Package Details
GetCloudRouterPackages Get /fabric/v4/routerPackages List Packages
SearchCloudRouterRoutes Post /fabric/v4/routers/{routerId}/routes/search Search Route Table
SearchCloudRouters Post /fabric/v4/routers/search Search Routers
UpdateCloudRouterByUuid Patch /fabric/v4/routers/{routerId} Update Routers

CreateCloudRouter

CloudRouter CreateCloudRouter(ctx, body) Create Routers

This API provides capability to create user's Cloud Routers

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body CloudRouterPostRequest

Return type

CloudRouter

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]

CreateCloudRouterAction

CloudRouterActionResponse CreateCloudRouterAction(ctx, body, routerId) Route table actions

This API provides capability to refresh route table and bgp session summary information

Required Parameters

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

Return type

CloudRouterActionResponse

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]

DeleteCloudRouterByUuid

DeleteCloudRouterByUuid(ctx, routerId) Delete Routers

This API provides capability to delete user's Cloud Routers

Required Parameters

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

Return type

(empty response body)

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]

GetCloudRouterActions

CloudRouterActionResponse GetCloudRouterActions(ctx, routerId, optional) Get actions

This API provides capability to fetch action status

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
routerId string Router UUID
optional *CloudRoutersApiGetCloudRouterActionsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CloudRoutersApiGetCloudRouterActionsOpts struct

Name Type Description Notes

state | optional.Interface of CloudRouterActionState| Action state |

Return type

CloudRouterActionResponse

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]

GetCloudRouterByUuid

CloudRouter GetCloudRouterByUuid(ctx, routerId) Get Routers

This API provides capability to retrieve user's Cloud Routers

Required Parameters

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

Return type

CloudRouter

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]

GetCloudRouterPackageByCode

CloudRouterPackage GetCloudRouterPackageByCode(ctx, routerPackageCode) Get Package Details

This API provides capability to retrieve user's Cloud Routers Package Details

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
routerPackageCode RouterPackageCode Equinix-assigned Cloud Router package identifier

Return type

CloudRouterPackage

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]

GetCloudRouterPackages

PackageResponse GetCloudRouterPackages(ctx, optional) List Packages

This API provides capability to retrieve user's Cloud Routers Packages

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *CloudRoutersApiGetCloudRouterPackagesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CloudRoutersApiGetCloudRouterPackagesOpts struct

Name Type Description Notes
offset optional.Int32 offset
limit optional.Int32 number of records to fetch

Return type

PackageResponse

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]

SearchCloudRouterRoutes

RouteTableEntrySearchResponse SearchCloudRouterRoutes(ctx, body, routerId) Search Route Table

The API provides capability to get list of user's Fabric Cloud Router route table entries using search criteria, including optional filtering, pagination and sorting

Required Parameters

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

Return type

RouteTableEntrySearchResponse

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]

SearchCloudRouters

SearchResponse SearchCloudRouters(ctx, body) Search Routers

The API provides capability to get list of user's Cloud Routers using search criteria, including optional filtering, pagination and sorting

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body CloudRouterSearchRequest

Return type

SearchResponse

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]

UpdateCloudRouterByUuid

CloudRouter UpdateCloudRouterByUuid(ctx, body, routerId) Update Routers

This API provides capability to update user's Cloud Routers

Required Parameters

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

Return type

CloudRouter

Authorization

BearerAuth

HTTP request headers

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

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