thousandeyes-sdk-python/thousandeyes-sdk-monitors/docs/ListBGPMonitorsApi.md

thousandeyes_sdk.monitors.ListBGPMonitorsApi

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

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

get_bgp_monitors

Monitors get_bgp_monitors(aid=aid)

List BGP monitors

Retrieves a list of BGP monitors available to your account in ThousandEyes, including public and private feeds.

Example

• Bearer Authentication (BearerAuth):

import thousandeyes_sdk.monitors
from thousandeyes_sdk.monitors.models.monitors import Monitors
from thousandeyes_sdk.monitors.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 = thousandeyes_sdk.client.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 = thousandeyes_sdk.client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with thousandeyes_sdk.monitors.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = thousandeyes_sdk.monitors.ListBGPMonitorsApi(api_client)
    aid = '1234' # 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 Exception as e:
        print("Exception when calling ListBGPMonitorsApi->get_bgp_monitors: %s\n" % e)

Parameters

Name	Type	Description	Notes
aid	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]

Return type

Monitors

Authorization

BearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/hal+json, application/problem+json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-

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