Skip to content

Latest commit

 

History

History
194 lines (121 loc) · 6.64 KB

TopologiesApi.md

File metadata and controls

194 lines (121 loc) · 6.64 KB

\TopologiesApi

All URIs are relative to https://penapi.pacnetconnect.com

Method HTTP request Description
Ttms100TopologyTagByTopotaguuidDelete Delete /ttms/1.0.0/topology_tag/{topotaguuid}/ Delete a topology tag
Ttms100TopologyTagByTopotaguuidGet Get /ttms/1.0.0/topology_tag/{topotaguuid}/ Get information about the specified topology tag
Ttms100TopologyTagByTopotaguuidPut Put /ttms/1.0.0/topology_tag/{topotaguuid}/ Update a topology tag's name and/or description
Ttms100TopologyTagGet Get /ttms/1.0.0/topology_tag List all topology tags
Ttms100TopologyTagObjectsByTopotaguuidGet Get /ttms/1.0.0/topology_tag/{topotaguuid}/objects/ List objects for Topology
Ttms100TopologyTagPost Post /ttms/1.0.0/topology_tag Create a named topology tag

Ttms100TopologyTagByTopotaguuidDelete

Ttms100TopologyTagByTopotaguuidDelete(ctx, topotaguuid) Delete a topology tag

Delete a topology tag

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
topotaguuid string Unique identifier representing a specific topology tag

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

Ttms100TopologyTagByTopotaguuidGet

Topology Ttms100TopologyTagByTopotaguuidGet(ctx, topotaguuid) Get information about the specified topology tag

Get information about the specified topology tag

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
topotaguuid string Unique identifier representing a specific topology tag

Return type

Topology

Authorization

No authorization required

HTTP request headers

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

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

Ttms100TopologyTagByTopotaguuidPut

Topology Ttms100TopologyTagByTopotaguuidPut(ctx, topotaguuid, optional) Update a topology tag's name and/or description

Update a topology tag's name and/or description

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
topotaguuid string Unique identifier representing a specific topology tag
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
topotaguuid string Unique identifier representing a specific topology tag
body Ttms100TopologyTagRequest

Return type

Topology

Authorization

No authorization required

HTTP request headers

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

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

Ttms100TopologyTagGet

[]Topology Ttms100TopologyTagGet(ctx, ) List all topology tags

List all topology tags

Required Parameters

This endpoint does not need any parameter.

Return type

[]Topology

Authorization

No authorization required

HTTP request headers

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

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

Ttms100TopologyTagObjectsByTopotaguuidGet

Ttms100TopologyTagObjectsResponse Ttms100TopologyTagObjectsByTopotaguuidGet(ctx, topotaguuid) List objects for Topology

List all objects (Endpoints, Links, VPorts, etc.) associated with the topology tag.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
topotaguuid string Unique identifier representing a specific topology tag

Return type

Ttms100TopologyTagObjectsResponse

Authorization

No authorization required

HTTP request headers

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

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

Ttms100TopologyTagPost

Topology Ttms100TopologyTagPost(ctx, optional) Create a named topology tag

Create a named topology tag

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
body Ttms100TopologyTagRequest

Return type

Topology

Authorization

No authorization required

HTTP request headers

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

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