Skip to content

Latest commit

 

History

History
217 lines (136 loc) · 7.1 KB

PortsApi.md

File metadata and controls

217 lines (136 loc) · 7.1 KB
Raw

{{classname}}

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

Method HTTP request Description
AddToLag Post /fabric/v4/ports/{portId}/physicalPorts/bulk Add to Lag
CreateBulkPort Post /fabric/v4/ports/bulk Create Port
CreatePort Post /fabric/v4/ports Create Port
GetPortByUuid Get /fabric/v4/ports/{portId} Get Port by uuid
GetPorts Get /fabric/v4/ports Get All Ports
GetVlans Get /fabric/v4/ports/{portUuid}/linkProtocols Get Vlans
SearchPorts Post /fabric/v4/ports/search Search ports

AddToLag

AllPhysicalPortsResponse AddToLag(ctx, body, portId) Add to Lag

Add Physical Ports to Virtual Port.<font color="red"> Preview

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body BulkPhysicalPort
portId string Port UUID

Return type

AllPhysicalPortsResponse

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]

CreateBulkPort

AllPortsResponse CreateBulkPort(ctx, body) Create Port

Create Port creates Equinix Fabric? Port.<font color="red"> Preview

Required Parameters

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

Return type

AllPortsResponse

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]

CreatePort

Port CreatePort(ctx, body) Create Port

Creates Equinix Fabric? Port.

Required Parameters

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

Return type

Port

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]

GetPortByUuid

Port GetPortByUuid(ctx, portId) Get Port by uuid

Get Port By uuid returns details of assigned and available Equinix Fabric port for the specified user credentials. The metro code attribute in the response shows the origin of the proposed connection.

Required Parameters

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

Return type

Port

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]

GetPorts

AllPortsResponse GetPorts(ctx, optional) Get All Ports

Get All Ports returns details of all assigned and available ports for the specified user credentials. The metro attribute in the response shows the origin of the proposed connection.

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a PortsApiGetPortsOpts struct

Name Type Description Notes
name optional.String port name to be provided if specific port(s) to be retrieved

Return type

AllPortsResponse

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]

GetVlans

LinkProtocolGetResponse GetVlans(ctx, portUuid) Get Vlans

The API provides capability to retrieve Vlans for a Port.

Required Parameters

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

Return type

LinkProtocolGetResponse

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]

SearchPorts

AllPortsResponse SearchPorts(ctx, body) Search ports

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

Return type

AllPortsResponse

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]