Skip to content

Latest commit

 

History

History
241 lines (150 loc) · 7.92 KB

NetworksApi.md

File metadata and controls

241 lines (150 loc) · 7.92 KB

{{classname}}

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

Method HTTP request Description
CreateNetwork Post /fabric/v4/networks Create Network
DeleteNetworkByUuid Delete /fabric/v4/networks/{networkId} Delete Network By ID
GetConnectionsByNetworkUuid Get /fabric/v4/networks/{networkId}/connections Get Connections
GetNetworkByUuid Get /fabric/v4/networks/{networkId} Get Network By ID
GetNetworkChangeByUuid Get /fabric/v4/networks/{networkId}/changes/{changeId} Get Change By ID
GetNetworkChanges Get /fabric/v4/networks/{networkId}/changes Get Network Changes
SearchNetworks Post /fabric/v4/networks/search Search Network
UpdateNetworkByUuid Patch /fabric/v4/networks/{networkId} Update Network By ID

CreateNetwork

Network CreateNetwork(ctx, body) Create Network

This API provides capability to create user's Fabric Network

Required Parameters

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

Return type

Network

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]

DeleteNetworkByUuid

Network DeleteNetworkByUuid(ctx, networkId) Delete Network By ID

This API provides capability to delete user's Fabric Network

Required Parameters

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

Return type

Network

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]

GetConnectionsByNetworkUuid

NetworkConnections GetConnectionsByNetworkUuid(ctx, networkId) Get Connections

The API provides capability to get list of user's Fabric Network connections

Required Parameters

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

Return type

NetworkConnections

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]

GetNetworkByUuid

Network GetNetworkByUuid(ctx, networkId) Get Network By ID

This API provides capability to retrieve user's Fabric Network

Required Parameters

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

Return type

Network

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]

GetNetworkChangeByUuid

NetworkChange GetNetworkChangeByUuid(ctx, networkId, changeId) Get Change By ID

This API provides capability to retrieve user's Fabric Network Change

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
networkId string Network UUID
changeId string Network Change UUID

Return type

NetworkChange

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]

GetNetworkChanges

NetworkChangeResponse GetNetworkChanges(ctx, networkId) Get Network Changes

The API provides capability to get list of user's Fabric Network changes

Required Parameters

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

Return type

NetworkChangeResponse

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]

SearchNetworks

NetworkSearchResponse SearchNetworks(ctx, body) Search Network

The API provides capability to get list of user's Fabric Network 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 NetworkSearchRequest

Return type

NetworkSearchResponse

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]

UpdateNetworkByUuid

Network UpdateNetworkByUuid(ctx, body, networkId) Update Network By ID

This API provides capability to update user's Fabric Network

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body []NetworkChangeOperation
networkId string Network UUID

Return type

Network

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]