ThousandEyes SDK Agents API
Project description
thousandeyes-sdk-agents
Overview
Manage all agents available to your account in ThousandEyes, including both Cloud and Enterprise Agents.
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 7.0.15
- 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-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.CloudAndEnterpriseAgentNotificationRulesApi(api_client)
notification_rule_id = '281474976710706' # str | Unique ID for the agent notification rule.
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:
# Retrieve agent notification rule
api_response = api_instance.get_agents_notification_rule(notification_rule_id, aid=aid)
print("The response of CloudAndEnterpriseAgentNotificationRulesApi->get_agents_notification_rule:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling CloudAndEnterpriseAgentNotificationRulesApi->get_agents_notification_rule: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://api.thousandeyes.com/v7
Class | Method | HTTP request | Description |
---|---|---|---|
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 |
ProxiesApi | get_agents_proxies | GET /agents/proxies | List agent proxies |
Documentation For Models
- AccountGroup
- Agent
- AgentBase
- AgentClusterAssignRequest
- AgentClusterUnassignRequest
- AgentDetails
- AgentDetailsExpand
- AgentIpv6Policy
- AgentListExpand
- AgentProxies
- AgentProxy
- AgentRequest
- AlertEmail
- AlertIntegrationBase
- AlertIntegrationType
- CloudAgentDetail
- CloudEnterpriseAgent
- CloudEnterpriseAgentType
- CloudEnterpriseAgents
- ClusterMember
- EnterpriseAgent
- EnterpriseAgentClusterDetail
- EnterpriseAgentData
- EnterpriseAgentDetail
- EnterpriseAgentIpv6Policy
- EnterpriseAgentResponseExpands
- EnterpriseAgentState
- Error
- ErrorDetail
- ErrorDetailCode
- InterfaceIpMapping
- Labels
- Link
- ListNotificationRulesResponse
- Notification
- NotificationRule
- NotificationRuleDetail
- NotificationRules
- ProxyAuthType
- ProxyType
- SelfLinks
- SimpleAgent
- SimpleEnterpriseAgent
- SimpleTest
- TestInterval
- TestLinks
- TestSelfLink
- TestType
- UnauthorizedError
- ValidationError
- ValidationErrorItem
Documentation For Authorization
Authentication schemes defined for the API:
BearerAuth
- Type: Bearer authentication
Author
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for thousandeyes_sdk_agents-1.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 510add5306ee67b363359e762b45c1d7265b616b115f2d8a7dc0da6714188f98 |
|
MD5 | 0f6c4f737554d5c224194a01bdfe8276 |
|
BLAKE2b-256 | 7cd00c365bf57c1feb32c6f80f1fcc82d4d1f27906e8476e9330e67bf35b1a70 |
Hashes for thousandeyes_sdk_agents-1.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a43d556607655a7db32e55965c120453246f2cd0c7bf62d4330cb3c4f57bfd32 |
|
MD5 | 5b02b329a44a0b663100798a1a3d9a7b |
|
BLAKE2b-256 | fa3ad437b4721d52881b7ca73d2d856160b872eb376350ef1ea79a62df40c550 |