thousandeyes-sdk-endpoint-agents

Manage ThousandEyes Endpoint Agents using this API.

For more information about Endpoint Agents, see Endpoint Agents.

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

API version: 7.0.10
Generator version: 7.6.0
Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

Requirements.

Python 3.8+

Installation & Usage

pip install

Install directly via PyPi:

pip install thousandeyes-sdk-endpoint-agents

(you may need to run pip with root permission: sudo pip install thousandeyes-sdk-endpoint-agents)

Then import the package:

import thousandeyes_sdk.endpoint_agents

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 thousandeyes_sdk.endpoint_agents

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:


import thousandeyes_sdk.core
import thousandeyes_sdk.endpoint_agents
from thousandeyes_sdk.core.exceptions 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.core.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.core.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with thousandeyes_sdk.core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = thousandeyes_sdk.endpoint_agents.AdministrativeEndpointsApi(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:
        # Get agent connection string
        api_response = api_instance.get_endpoint_agents_connection_string(aid=aid)
        print("The response of AdministrativeEndpointsApi->get_endpoint_agents_connection_string:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AdministrativeEndpointsApi->get_endpoint_agents_connection_string: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AdministrativeEndpointsApi	get_endpoint_agents_connection_string	GET /v7/endpoint/agents/connection-string	Get agent connection string
ManageAgentsApi	delete_endpoint_agent	DELETE /v7/endpoint/agents/{agentId}	Delete endpoint agent
ManageAgentsApi	disable_endpoint_agent	POST /v7/endpoint/agents/{agentId}/disable	Disable endpoint agent
ManageAgentsApi	enable_endpoint_agent	POST /v7/endpoint/agents/{agentId}/enable	Enable endpoint agent
ManageAgentsApi	filter_endpoint_agents	POST /v7/endpoint/agents/filter	Filter endpoint agents
ManageAgentsApi	get_endpoint_agent	GET /v7/endpoint/agents/{agentId}	Retrieve endpoint agent
ManageAgentsApi	get_endpoint_agents	GET /v7/endpoint/agents	List endpoint agents
ManageAgentsApi	update_endpoint_agent	PATCH /v7/endpoint/agents/{agentId}	Update endpoint agent
TransferApi	transfer_endpoint_agent	POST /v7/endpoint/agents/{agentId}/transfer	Transfer endpoint agent
TransferApi	transfer_endpoint_agents	POST /v7/endpoint/agents/transfer/bulk	Bulk transfer agents

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

Type: Bearer authentication

Author

ThousandEyes API Team

13 KiB Raw Blame History