thousandeyes-sdk-agents

Overview

Manage Cloud and Enterprise Agents available to your account in ThousandEyes.

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

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

Requirements.

Python 3.9+

Installation & Usage

pip install

Install directly via PyPi:

pip install thousandeyes-sdk-agents

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

Then import the package:

import thousandeyes_sdk.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.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.agents
from thousandeyes_sdk.core.exceptions import ApiException
from pprint import pprint

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

# 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.agents.AgentProxiesApi(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 Enterprise Agent Proxies
        api_response = api_instance.get_agents_proxies(aid=aid)
        print("The response of AgentProxiesApi->get_agents_proxies:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AgentProxiesApi->get_agents_proxies: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AgentProxiesApi	get_agents_proxies	GET /agents/proxies	List Enterprise Agent Proxies
CloudAndEnterpriseAgentNotificationRulesApi	get_agents_notification_rule	GET /agents/notification-rules/{notificationRuleId}	Retrieve agent notification rule
CloudAndEnterpriseAgentNotificationRulesApi	get_agents_notification_rules	GET /agents/notification-rules	List agent notification rules
CloudAndEnterpriseAgentsApi	delete_agent	DELETE /agents/{agentId}	Delete Enterprise Agent
CloudAndEnterpriseAgentsApi	get_agent	GET /agents/{agentId}	Retrieve Cloud and Enterprise Agent
CloudAndEnterpriseAgentsApi	get_agents	GET /agents	List Cloud and Enterprise Agents
CloudAndEnterpriseAgentsApi	update_agent	PUT /agents/{agentId}	Update Enterprise Agent
EnterpriseAgentClusterApi	assign_agent_to_cluster	POST /agents/{agentId}/cluster/assign	Add member to Enterprise Agent cluster
EnterpriseAgentClusterApi	unassign_agent_from_cluster	POST /agents/{agentId}/cluster/unassign	Remove member from Enterprise Agent cluster
LocalProblemsApi	get_agents_local_problems	GET /agents/local-problems	List Cloud agents with local problems
TestsAssignmentOnAgentsApi	assign_tests	POST /agents/{agentId}/tests/assign	Assign tests to an agent
TestsAssignmentOnAgentsApi	overwrite_tests	POST /agents/{agentId}/tests/override	Overwrite tests assigned to an agent
TestsAssignmentOnAgentsApi	unassign_tests	POST /agents/{agentId}/tests/unassign	Unassign tests from an agent

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

Type: Bearer authentication

Author

ThousandEyes API Team

Metadata

Release files for thousandeyes-sdk-agents 5.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for thousandeyes-sdk-agents 5.0.1
File	Size	Uploaded
thousandeyes_sdk_agents-5.0.1.tar.gz	84.7 kB	Sep 9, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for thousandeyes-sdk-agents 5.0.1
File	Interpreter	ABI	Platform	Reset
thousandeyes_sdk_agents-5.0.1-py3-none-any.whl 128.5 kB Sep 9, 2026	Python 3	none	any	Details

Total release size: 213.2 kB

Release files / thousandeyes_sdk_agents-5.0.1.tar.gz

Download URL	thousandeyes_sdk_agents-5.0.1.tar.gz
Size	84.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`9824ef859a89dd736f4e899bcbef7d3faf98cc2c6cd9e3596035cb6c6b1d33cd`
BLAKE2b-256 checksum How to use checksums	`54a9462ad96296d91544b1eb5196f735aa532ffa99c6709f29f4652ec883d800`
Upload date	Sep 9, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/thousandeyes/thousandeyes-sdk-python
Publishing commit: github.com/thousandeyes/thousandeyes-sdk-python/tree/9fa78bf5ac190335dc468a8eec289addfcb58e8f

Workflow

Publishing configuration: github.com/thousandeyes/thousandeyes-sdk-python/blob/9fa78bf5ac190335dc468a8eec289addfcb58e8f/.github/workflows/release.yaml
Publishing logs: github.com/thousandeyes/thousandeyes-sdk-python/actions/runs/34374680639/attempts/1

Artifact

Subject: thousandeyes_sdk_agents-5.0.1.tar.gz
SHA-256 checksum: 9824ef859a89dd736f4e899bcbef7d3faf98cc2c6cd9e3596035cb6c6b1d33cd Verifying attestations

Release files / thousandeyes_sdk_agents-5.0.1-py3-none-any.whl

Download URL	thousandeyes_sdk_agents-5.0.1-py3-none-any.whl
Size	128.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`d8b5bc8336979d290ac034ad7e603f84a683a31cdf293964b434e1ebcd2746d3`
BLAKE2b-256 checksum How to use checksums	`3aef1f6ce106e2a16286f8a532a18a79ad6de8eb90e2e49781fe16dd3eedde75`
Upload date	Sep 9, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/thousandeyes/thousandeyes-sdk-python
Publishing commit: github.com/thousandeyes/thousandeyes-sdk-python/tree/9fa78bf5ac190335dc468a8eec289addfcb58e8f

Workflow

Publishing configuration: github.com/thousandeyes/thousandeyes-sdk-python/blob/9fa78bf5ac190335dc468a8eec289addfcb58e8f/.github/workflows/release.yaml
Publishing logs: github.com/thousandeyes/thousandeyes-sdk-python/actions/runs/34374680639/attempts/1

Artifact

Subject: thousandeyes_sdk_agents-5.0.1-py3-none-any.whl
SHA-256 checksum: d8b5bc8336979d290ac034ad7e603f84a683a31cdf293964b434e1ebcd2746d3 Verifying attestations