thousandeyes-sdk-python/monitors_api/README.md

monitors-api

Overview

Retrieve information about BGP monitors available for ThousandEyes account.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 7.0.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/thousandeyes/thousandeyes-python-sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/thousandeyes/thousandeyes-python-sdk.git)

Then import the package:

import monitors_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import monitors_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import monitors_api
from monitors_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.thousandeyes.com
# See configuration.py for a list of all supported configuration parameters.
configuration = monitors_api.Configuration(
    host = "https://api.thousandeyes.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: BearerAuth
configuration = monitors_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with monitors_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = monitors_api.ListBGPMonitorsApi(api_client)
    aid = '2067' # str | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. (optional)

    try:
        # List BGP monitors
        api_response = api_instance.get_bgp_monitors(aid=aid)
        print("The response of ListBGPMonitorsApi->get_bgp_monitors:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ListBGPMonitorsApi->get_bgp_monitors: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
ListBGPMonitorsApi	get_bgp_monitors	GET /v7/monitors	List BGP monitors

Documentation For Models

• Error
• GetBGPMonitors200Response
• Link
• Monitor
• MonitorType
• Monitors
• SelfLinks
• SelfLinksLinks
• UnauthorizedError

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: Bearer authentication

Author