Skip to content

Latest commit

 

History

History
220 lines (138 loc) · 7.55 KB

ConnectionsApi.md

File metadata and controls

220 lines (138 loc) · 7.55 KB
Raw

{{classname}}

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

Method HTTP request Description
CreateConnection Post /fabric/v4/connections Create Connection
CreateConnectionAction Post /fabric/v4/connections/{connectionId}/actions Connection Actions
DeleteConnectionByUuid Delete /fabric/v4/connections/{connectionId} Delete by ID
GetConnectionByUuid Get /fabric/v4/connections/{connectionId} Get Connection by ID
SearchConnections Post /fabric/v4/connections/search Search connections
UpdateConnectionByUuid Patch /fabric/v4/connections/{connectionId} Update by ID
ValidateConnections Post /fabric/v4/connections/validate Validate Connection

CreateConnection

Connection CreateConnection(ctx, body) Create Connection

This API provides capability to create user's virtual connection

Required Parameters

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

Return type

Connection

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]

CreateConnectionAction

ConnectionAction CreateConnectionAction(ctx, body, connectionId) Connection Actions

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.
body ConnectionActionRequest
connectionId string Connection Id

Return type

ConnectionAction

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]

DeleteConnectionByUuid

Connection DeleteConnectionByUuid(ctx, connectionId) Delete by ID

Delete Connection by ID

Required Parameters

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

Return type

Connection

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]

GetConnectionByUuid

Connection GetConnectionByUuid(ctx, connectionId, optional) Get Connection by ID

The API provides capability to get user's virtual connection details (Service Tokens, Access Points, Link Protocols, etc) by it's connection ID (UUID)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a ConnectionsApiGetConnectionByUuidOpts struct

Name Type Description Notes

direction | optional.Interface of ConnectionDirection| Connection Direction |

Return type

Connection

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]

SearchConnections

ConnectionSearchResponse SearchConnections(ctx, body) Search connections

The API provides capability to get list of user's virtual connections 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 SearchRequest

Return type

ConnectionSearchResponse

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]

UpdateConnectionByUuid

Connection UpdateConnectionByUuid(ctx, body, connectionId) Update by ID

Update Connection by ID

Required Parameters

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

Return type

Connection

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]

ValidateConnections

ConnectionResponse ValidateConnections(ctx, body) Validate Connection

This API provides capability to validate by auth key

Required Parameters

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

Return type

ConnectionResponse

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]