mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2025-12-06 07:55:31 +00:00
187 lines
8.0 KiB
Markdown
187 lines
8.0 KiB
Markdown
# agents-api
|
|
|
|
## 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](https://openapi-generator.tech) 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:
|
|
|
|
```sh
|
|
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:
|
|
```python
|
|
import agents_api
|
|
```
|
|
|
|
### Setuptools
|
|
|
|
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
|
|
|
|
```sh
|
|
python setup.py install --user
|
|
```
|
|
(or `sudo python setup.py install` to install the package for all users)
|
|
|
|
Then import the package:
|
|
```python
|
|
import agents_api
|
|
```
|
|
|
|
### Tests
|
|
|
|
Execute `pytest` to run the tests.
|
|
|
|
## Getting Started
|
|
|
|
Please follow the [installation procedure](#installation--usage) and then run the following:
|
|
|
|
```python
|
|
|
|
import time
|
|
import agents_api
|
|
from agents_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 = agents_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 = agents_api.Configuration(
|
|
access_token = os.environ["BEARER_TOKEN"]
|
|
)
|
|
|
|
|
|
# Enter a context with an instance of the API client
|
|
with agents_api.ApiClient(configuration) as api_client:
|
|
# Create an instance of the API class
|
|
api_instance = agents_api.CloudAndEnterpriseAgentNotificationRulesApi(api_client)
|
|
notification_rule_id = '281474976710706' # str | Unique ID for the agent notification rule.
|
|
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:
|
|
# 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*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*CloudAndEnterpriseAgentNotificationRulesApi* | [**get_agents_notification_rule**](docs/CloudAndEnterpriseAgentNotificationRulesApi.md#get_agents_notification_rule) | **GET** /v7/agents/notification-rules/{notificationRuleId} | Retrieve agent notification rule
|
|
*CloudAndEnterpriseAgentNotificationRulesApi* | [**get_agents_notification_rules**](docs/CloudAndEnterpriseAgentNotificationRulesApi.md#get_agents_notification_rules) | **GET** /v7/agents/notification-rules | List agent notification rules
|
|
*CloudAndEnterpriseAgentsApi* | [**delete_enterprise_agent**](docs/CloudAndEnterpriseAgentsApi.md#delete_enterprise_agent) | **DELETE** /v7/agents/{agentId} | Delete Enterprise Agent
|
|
*CloudAndEnterpriseAgentsApi* | [**get_agent_details**](docs/CloudAndEnterpriseAgentsApi.md#get_agent_details) | **GET** /v7/agents/{agentId} | Retrieve Cloud and Enterprise Agent
|
|
*CloudAndEnterpriseAgentsApi* | [**get_agents**](docs/CloudAndEnterpriseAgentsApi.md#get_agents) | **GET** /v7/agents | List Cloud and Enterprise Agents
|
|
*CloudAndEnterpriseAgentsApi* | [**update_enterprise_agent_details**](docs/CloudAndEnterpriseAgentsApi.md#update_enterprise_agent_details) | **PUT** /v7/agents/{agentId} | Update Enterprise Agent
|
|
*EnterpriseAgentClusterApi* | [**assign_enterprise_agent_cluster**](docs/EnterpriseAgentClusterApi.md#assign_enterprise_agent_cluster) | **POST** /v7/agents/{agentId}/cluster/assign | Add member to Enterprise Agent cluster
|
|
*EnterpriseAgentClusterApi* | [**unassign_enterprise_agent_from_cluster**](docs/EnterpriseAgentClusterApi.md#unassign_enterprise_agent_from_cluster) | **POST** /v7/agents/{agentId}/cluster/unassign | Remove member from Enterprise Agent cluster
|
|
*ProxiesApi* | [**get_agent_proxies**](docs/ProxiesApi.md#get_agent_proxies) | **GET** /v7/agents/proxies | List agent proxies
|
|
|
|
|
|
## Documentation For Models
|
|
|
|
- [AccountGroup](docs/AccountGroup.md)
|
|
- [AccountGroupId](docs/AccountGroupId.md)
|
|
- [Agent](docs/Agent.md)
|
|
- [AgentBase](docs/AgentBase.md)
|
|
- [AgentDetail](docs/AgentDetail.md)
|
|
- [AgentDetails](docs/AgentDetails.md)
|
|
- [AgentDetailsExpand](docs/AgentDetailsExpand.md)
|
|
- [AgentIpv6Policy](docs/AgentIpv6Policy.md)
|
|
- [AgentListExpand](docs/AgentListExpand.md)
|
|
- [AgentProxies](docs/AgentProxies.md)
|
|
- [AgentProxy](docs/AgentProxy.md)
|
|
- [Agents](docs/Agents.md)
|
|
- [AlertEmail](docs/AlertEmail.md)
|
|
- [AlertIntegrationBase](docs/AlertIntegrationBase.md)
|
|
- [AlertIntegrationType](docs/AlertIntegrationType.md)
|
|
- [AssignEnterpriseAgentClusterRequest](docs/AssignEnterpriseAgentClusterRequest.md)
|
|
- [CloudEnterpriseAgent](docs/CloudEnterpriseAgent.md)
|
|
- [CloudEnterpriseAgentType](docs/CloudEnterpriseAgentType.md)
|
|
- [CloudEnterpriseAgents](docs/CloudEnterpriseAgents.md)
|
|
- [ClusterMember](docs/ClusterMember.md)
|
|
- [EnterpriseAgent](docs/EnterpriseAgent.md)
|
|
- [EnterpriseAgentDetail](docs/EnterpriseAgentDetail.md)
|
|
- [EnterpriseAgentIpv6Policy](docs/EnterpriseAgentIpv6Policy.md)
|
|
- [EnterpriseAgentRequestBody](docs/EnterpriseAgentRequestBody.md)
|
|
- [EnterpriseAgentState](docs/EnterpriseAgentState.md)
|
|
- [Error](docs/Error.md)
|
|
- [ErrorDetail](docs/ErrorDetail.md)
|
|
- [ErrorDetailCode](docs/ErrorDetailCode.md)
|
|
- [GetAgentDetails200Response](docs/GetAgentDetails200Response.md)
|
|
- [GetAgentProxies200Response](docs/GetAgentProxies200Response.md)
|
|
- [GetAgents200Response](docs/GetAgents200Response.md)
|
|
- [GetAgentsNotificationRule200Response](docs/GetAgentsNotificationRule200Response.md)
|
|
- [GetAgentsNotificationRules200Response](docs/GetAgentsNotificationRules200Response.md)
|
|
- [InterfaceIpMapping](docs/InterfaceIpMapping.md)
|
|
- [Labels](docs/Labels.md)
|
|
- [Link](docs/Link.md)
|
|
- [Notification](docs/Notification.md)
|
|
- [NotificationRule](docs/NotificationRule.md)
|
|
- [NotificationRuleDetail](docs/NotificationRuleDetail.md)
|
|
- [NotificationRules](docs/NotificationRules.md)
|
|
- [Notifications](docs/Notifications.md)
|
|
- [ProxyAuthType](docs/ProxyAuthType.md)
|
|
- [ProxyType](docs/ProxyType.md)
|
|
- [SelfLinks](docs/SelfLinks.md)
|
|
- [SelfLinksLinks](docs/SelfLinksLinks.md)
|
|
- [SimpleTest](docs/SimpleTest.md)
|
|
- [TestInterval](docs/TestInterval.md)
|
|
- [TestType](docs/TestType.md)
|
|
- [UnassignEnterpriseAgentFromClusterRequest](docs/UnassignEnterpriseAgentFromClusterRequest.md)
|
|
- [UnauthorizedError](docs/UnauthorizedError.md)
|
|
- [UnexpandedInstantTest](docs/UnexpandedInstantTest.md)
|
|
- [UnexpandedInstantTestLinks](docs/UnexpandedInstantTestLinks.md)
|
|
- [UnexpandedInstantTestLinksSelf](docs/UnexpandedInstantTestLinksSelf.md)
|
|
- [UnexpandedInstantTestLinksTestResults](docs/UnexpandedInstantTestLinksTestResults.md)
|
|
- [UnexpandedTest](docs/UnexpandedTest.md)
|
|
- [UpdateEnterpriseAgentDetails200Response](docs/UpdateEnterpriseAgentDetails200Response.md)
|
|
|
|
|
|
<a id="documentation-for-authorization"></a>
|
|
## Documentation For Authorization
|
|
|
|
|
|
Authentication schemes defined for the API:
|
|
<a id="BearerAuth"></a>
|
|
### BearerAuth
|
|
|
|
- **Type**: Bearer authentication
|
|
|
|
|
|
## Author
|
|
|
|
|
|
|
|
|