Skip to content

Latest commit

 

History

History
471 lines (331 loc) · 15.1 KB

TopologiesApi.md

File metadata and controls

471 lines (331 loc) · 15.1 KB

TelstraTPN.TopologiesApi

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

Method HTTP request Description
endpoints_assign_topology_tag POST /eis/1.0.0/endpoints/{endpointuuid}/assign_topology_tag Assign an Endpoint to a Topology
endpoints_topology_tag_uuid GET /eis/1.0.0/endpoints/topology_tag_uuid/{topotaguuid} List Endpoints for Topology
endpoints_topology_tag_uuid_endpoint DELETE /eis/1.0.0/endpoints/topology_tag_uuid/{topotaguuid}/endpoint/{endpointuuid} Remove Endpoint from a Topology
topology_tag_get GET /ttms/1.0.0/topology_tag List all topology tags
topology_tag_objects GET /ttms/1.0.0/topology_tag/{topotaguuid}/objects/ List objects for Topology
topology_tag_post POST /ttms/1.0.0/topology_tag Create a named topology tag
topology_tag_uuid_delete DELETE /ttms/1.0.0/topology_tag/{topotaguuid}/ Delete a topology tag
topology_tag_uuid_get GET /ttms/1.0.0/topology_tag/{topotaguuid}/ Get information about the specified topology tag
topology_tag_uuid_put PUT /ttms/1.0.0/topology_tag/{topotaguuid}/ Update a topology tag's name and/or description

endpoints_assign_topology_tag

SuccessFragment endpoints_assign_topology_tag(endpointuuid, assigntopotagrequest=assigntopotagrequest)

Assign an Endpoint to a Topology

Example

from __future__ import print_function
import time
import TelstraTPN
from TelstraTPN.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oAuth2
configuration = TelstraTPN.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = TelstraTPN.TopologiesApi(TelstraTPN.ApiClient(configuration))
endpointuuid = 'endpointuuid_example' # str | Unique identifier representing a specific endpoint
assigntopotagrequest = TelstraTPN.Assigntopotagrequest() # Assigntopotagrequest |  (optional)

try:
    # Assign an Endpoint to a Topology
    api_response = api_instance.endpoints_assign_topology_tag(endpointuuid, assigntopotagrequest=assigntopotagrequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopologiesApi->endpoints_assign_topology_tag: %s\n" % e)

Parameters

Name Type Description Notes
endpointuuid str Unique identifier representing a specific endpoint
assigntopotagrequest Assigntopotagrequest [optional]

Return type

SuccessFragment

Authorization

oAuth2

HTTP request headers

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

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

endpoints_topology_tag_uuid

InlineResponse20014 endpoints_topology_tag_uuid(topotaguuid)

List Endpoints for Topology

List all Endpoints associated with the topology tag.

Example

from __future__ import print_function
import time
import TelstraTPN
from TelstraTPN.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oAuth2
configuration = TelstraTPN.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = TelstraTPN.TopologiesApi(TelstraTPN.ApiClient(configuration))
topotaguuid = 'topotaguuid_example' # str | Unique identifier representing a specific topology tag

try:
    # List Endpoints for Topology
    api_response = api_instance.endpoints_topology_tag_uuid(topotaguuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopologiesApi->endpoints_topology_tag_uuid: %s\n" % e)

Parameters

Name Type Description Notes
topotaguuid str Unique identifier representing a specific topology tag

Return type

InlineResponse20014

Authorization

oAuth2

HTTP request headers

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

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

endpoints_topology_tag_uuid_endpoint

endpoints_topology_tag_uuid_endpoint(topotaguuid, endpointuuid)

Remove Endpoint from a Topology

Example

from __future__ import print_function
import time
import TelstraTPN
from TelstraTPN.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oAuth2
configuration = TelstraTPN.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = TelstraTPN.TopologiesApi(TelstraTPN.ApiClient(configuration))
topotaguuid = 'topotaguuid_example' # str | Unique identifier representing a specific topology tag
endpointuuid = 'endpointuuid_example' # str | Unique identifier representing a specific endpoint

try:
    # Remove Endpoint from a Topology
    api_instance.endpoints_topology_tag_uuid_endpoint(topotaguuid, endpointuuid)
except ApiException as e:
    print("Exception when calling TopologiesApi->endpoints_topology_tag_uuid_endpoint: %s\n" % e)

Parameters

Name Type Description Notes
topotaguuid str Unique identifier representing a specific topology tag
endpointuuid str Unique identifier representing a specific endpoint

Return type

void (empty response body)

Authorization

oAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

topology_tag_get

list[Topology] topology_tag_get()

List all topology tags

Example

from __future__ import print_function
import time
import TelstraTPN
from TelstraTPN.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oAuth2
configuration = TelstraTPN.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = TelstraTPN.TopologiesApi(TelstraTPN.ApiClient(configuration))

try:
    # List all topology tags
    api_response = api_instance.topology_tag_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopologiesApi->topology_tag_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[Topology]

Authorization

oAuth2

HTTP request headers

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

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

topology_tag_objects

InlineResponse20013 topology_tag_objects(topotaguuid)

List objects for Topology

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

Example

from __future__ import print_function
import time
import TelstraTPN
from TelstraTPN.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oAuth2
configuration = TelstraTPN.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = TelstraTPN.TopologiesApi(TelstraTPN.ApiClient(configuration))
topotaguuid = 'topotaguuid_example' # str | Unique identifier representing a specific topology tag

try:
    # List objects for Topology
    api_response = api_instance.topology_tag_objects(topotaguuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopologiesApi->topology_tag_objects: %s\n" % e)

Parameters

Name Type Description Notes
topotaguuid str Unique identifier representing a specific topology tag

Return type

InlineResponse20013

Authorization

oAuth2

HTTP request headers

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

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

topology_tag_post

Topology topology_tag_post(topotagcreaterequest=topotagcreaterequest)

Create a named topology tag

Example

from __future__ import print_function
import time
import TelstraTPN
from TelstraTPN.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oAuth2
configuration = TelstraTPN.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = TelstraTPN.TopologiesApi(TelstraTPN.ApiClient(configuration))
topotagcreaterequest = TelstraTPN.Topotagcreaterequest() # Topotagcreaterequest |  (optional)

try:
    # Create a named topology tag
    api_response = api_instance.topology_tag_post(topotagcreaterequest=topotagcreaterequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopologiesApi->topology_tag_post: %s\n" % e)

Parameters

Name Type Description Notes
topotagcreaterequest Topotagcreaterequest [optional]

Return type

Topology

Authorization

oAuth2

HTTP request headers

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

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

topology_tag_uuid_delete

topology_tag_uuid_delete(topotaguuid)

Delete a topology tag

Example

from __future__ import print_function
import time
import TelstraTPN
from TelstraTPN.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oAuth2
configuration = TelstraTPN.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = TelstraTPN.TopologiesApi(TelstraTPN.ApiClient(configuration))
topotaguuid = 'topotaguuid_example' # str | Unique identifier representing a specific topology tag

try:
    # Delete a topology tag
    api_instance.topology_tag_uuid_delete(topotaguuid)
except ApiException as e:
    print("Exception when calling TopologiesApi->topology_tag_uuid_delete: %s\n" % e)

Parameters

Name Type Description Notes
topotaguuid str Unique identifier representing a specific topology tag

Return type

void (empty response body)

Authorization

oAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

topology_tag_uuid_get

Topology topology_tag_uuid_get(topotaguuid)

Get information about the specified topology tag

Example

from __future__ import print_function
import time
import TelstraTPN
from TelstraTPN.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oAuth2
configuration = TelstraTPN.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = TelstraTPN.TopologiesApi(TelstraTPN.ApiClient(configuration))
topotaguuid = 'topotaguuid_example' # str | Unique identifier representing a specific topology tag

try:
    # Get information about the specified topology tag
    api_response = api_instance.topology_tag_uuid_get(topotaguuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopologiesApi->topology_tag_uuid_get: %s\n" % e)

Parameters

Name Type Description Notes
topotaguuid str Unique identifier representing a specific topology tag

Return type

Topology

Authorization

oAuth2

HTTP request headers

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

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

topology_tag_uuid_put

Topology topology_tag_uuid_put(topotaguuid, topotagupdateresponse=topotagupdateresponse)

Update a topology tag's name and/or description

Example

from __future__ import print_function
import time
import TelstraTPN
from TelstraTPN.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oAuth2
configuration = TelstraTPN.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = TelstraTPN.TopologiesApi(TelstraTPN.ApiClient(configuration))
topotaguuid = 'topotaguuid_example' # str | Unique identifier representing a specific topology tag
topotagupdateresponse = TelstraTPN.Topotagupdateresponse() # Topotagupdateresponse |  (optional)

try:
    # Update a topology tag's name and/or description
    api_response = api_instance.topology_tag_uuid_put(topotaguuid, topotagupdateresponse=topotagupdateresponse)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopologiesApi->topology_tag_uuid_put: %s\n" % e)

Parameters

Name Type Description Notes
topotaguuid str Unique identifier representing a specific topology tag
topotagupdateresponse Topotagupdateresponse [optional]

Return type

Topology

Authorization

oAuth2

HTTP request headers

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

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