Skip to content

Latest commit

 

History

History
276 lines (178 loc) · 10.4 KB

ServiceProfilesApi.md

File metadata and controls

276 lines (178 loc) · 10.4 KB
Raw

{{classname}}

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

Method HTTP request Description
CreateServiceProfile Post /fabric/v4/serviceProfiles Create Profile
DeleteServiceProfileByUuid Delete /fabric/v4/serviceProfiles/{serviceProfileId} Delete Profile
GetServiceProfileByUuid Get /fabric/v4/serviceProfiles/{serviceProfileId} Get Profile
GetServiceProfileMetrosByUuid Get /fabric/v4/serviceProfiles/{serviceProfileId}/metros Get Profile Metros
GetServiceProfiles Get /fabric/v4/serviceProfiles Get all Profiles
PutServiceProfileByUuid Put /fabric/v4/serviceProfiles/{serviceProfileId} Replace Profile
SearchServiceProfiles Post /fabric/v4/serviceProfiles/search Profile Search
UpdateServiceProfileByUuid Patch /fabric/v4/serviceProfiles/{serviceProfileId} Update Profile

CreateServiceProfile

ServiceProfile CreateServiceProfile(ctx, body) Create Profile

Create Service Profile creates Equinix Fabric? Service Profile.

Required Parameters

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

Return type

ServiceProfile

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json; charset=UTF-8, application/json

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

DeleteServiceProfileByUuid

ServiceProfile DeleteServiceProfileByUuid(ctx, serviceProfileId) Delete Profile

delete Service Profile by UUID

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceProfileId string Service Profile UUID

Return type

ServiceProfile

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=UTF-8, application/json

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

GetServiceProfileByUuid

ServiceProfile GetServiceProfileByUuid(ctx, serviceProfileId, optional) Get Profile

Get service profile by UUID. View Point parameter if set to zSide will give seller's view of the profile otherwise buyer's view.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceProfileId string Service Profile UUID
optional *ServiceProfilesApiGetServiceProfileByUuidOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ServiceProfilesApiGetServiceProfileByUuidOpts struct

Name Type Description Notes

viewPoint | optional.String| flips view between buyer and seller representation | [default to aSide]

Return type

ServiceProfile

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=UTF-8, application/json

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

GetServiceProfileMetrosByUuid

ServiceMetros GetServiceProfileMetrosByUuid(ctx, serviceProfileId, optional) Get Profile Metros

Get service profile metros by UUID.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
serviceProfileId string Service Profile UUID
optional *ServiceProfilesApiGetServiceProfileMetrosByUuidOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ServiceProfilesApiGetServiceProfileMetrosByUuidOpts struct

Name Type Description Notes

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

Return type

ServiceMetros

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=UTF-8, application/json

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

GetServiceProfiles

ServiceProfiles GetServiceProfiles(ctx, optional) Get all Profiles

The API request returns all Equinix Fabric Service Profiles in accordance with the view point requested.

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a ServiceProfilesApiGetServiceProfilesOpts struct

Name Type Description Notes
offset optional.Int32 offset
limit optional.Int32 number of records to fetch
viewPoint optional.String flips view between buyer and seller representation [default to aSide]

Return type

ServiceProfiles

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=UTF-8, application/json

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

PutServiceProfileByUuid

ServiceProfile PutServiceProfileByUuid(ctx, body, serviceProfileId, ifMatch) Replace Profile

This API request replaces a service profile definition

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body ServiceProfileRequest
serviceProfileId string Service Profile UUID
ifMatch string conditional request

Return type

ServiceProfile

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json; charset=UTF-8, application/json

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

SearchServiceProfiles

ServiceProfiles SearchServiceProfiles(ctx, body, optional) Profile Search

Search service profiles by search criteria

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a ServiceProfilesApiSearchServiceProfilesOpts struct

Name Type Description Notes

viewPoint | optional.| flips view between buyer and seller representation | [default to aSide]

Return type

ServiceProfiles

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json; charset=UTF-8, application/json

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

UpdateServiceProfileByUuid

ServiceProfile UpdateServiceProfileByUuid(ctx, body, serviceProfileId, ifMatch) Update Profile

Update Service Profile by UUID

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body []JsonPatchOperation
serviceProfileId string Service Profile UUID
ifMatch string conditional request

Return type

ServiceProfile

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json-patch+json
  • Accept: application/json; charset=UTF-8, application/json

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