thousandeyes-sdk-python/thousandeyes-sdk-agents/README.md

# 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](https://openapi-generator.tech) project:

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

## 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 -e git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git#egg=thousandeyes-sdk-agents\&subdirectory=thousandeyes-sdk-agents
```
(you may need to run `pip` with root permission: `sudo pip install -e git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git#egg=thousandeyes-sdk-agents\&subdirectory=thousandeyes-sdk-agents`)

Then import the package:
```python
import thousandeyes_sdk.agents
```

### 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 thousandeyes_sdk.agents
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import thousandeyes_sdk.client
import thousandeyes_sdk.agents
from thousandeyes_sdk.client.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.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.client.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*

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_agent**](docs/CloudAndEnterpriseAgentsApi.md#delete_agent) | **DELETE** /v7/agents/{agentId} | Delete Enterprise Agent
*CloudAndEnterpriseAgentsApi* | [**get_agent**](docs/CloudAndEnterpriseAgentsApi.md#get_agent) | **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_agent**](docs/CloudAndEnterpriseAgentsApi.md#update_agent) | **PUT** /v7/agents/{agentId} | Update Enterprise Agent
*EnterpriseAgentClusterApi* | [**assign_agent_to_cluster**](docs/EnterpriseAgentClusterApi.md#assign_agent_to_cluster) | **POST** /v7/agents/{agentId}/cluster/assign | Add member to Enterprise Agent cluster
*EnterpriseAgentClusterApi* | [**unassign_agent_from_cluster**](docs/EnterpriseAgentClusterApi.md#unassign_agent_from_cluster) | **POST** /v7/agents/{agentId}/cluster/unassign | Remove member from Enterprise Agent cluster
*ProxiesApi* | [**get_agents_proxies**](docs/ProxiesApi.md#get_agents_proxies) | **GET** /v7/agents/proxies | List agent proxies


## Documentation For Models

 - [AccountGroup](docs/AccountGroup.md)
 - [Agent](docs/Agent.md)
 - [AgentBase](docs/AgentBase.md)
 - [AgentClusterAssignRequest](docs/AgentClusterAssignRequest.md)
 - [AgentClusterUnassignRequest](docs/AgentClusterUnassignRequest.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)
 - [AgentRequest](docs/AgentRequest.md)
 - [AlertEmail](docs/AlertEmail.md)
 - [AlertIntegrationBase](docs/AlertIntegrationBase.md)
 - [AlertIntegrationType](docs/AlertIntegrationType.md)
 - [CloudAgentDetail](docs/CloudAgentDetail.md)
 - [CloudEnterpriseAgent](docs/CloudEnterpriseAgent.md)
 - [CloudEnterpriseAgentType](docs/CloudEnterpriseAgentType.md)
 - [CloudEnterpriseAgents](docs/CloudEnterpriseAgents.md)
 - [ClusterMember](docs/ClusterMember.md)
 - [EnterpriseAgent](docs/EnterpriseAgent.md)
 - [EnterpriseAgentClusterDetail](docs/EnterpriseAgentClusterDetail.md)
 - [EnterpriseAgentData](docs/EnterpriseAgentData.md)
 - [EnterpriseAgentDetail](docs/EnterpriseAgentDetail.md)
 - [EnterpriseAgentIpv6Policy](docs/EnterpriseAgentIpv6Policy.md)
 - [EnterpriseAgentResponseExpands](docs/EnterpriseAgentResponseExpands.md)
 - [EnterpriseAgentState](docs/EnterpriseAgentState.md)
 - [Error](docs/Error.md)
 - [ErrorDetail](docs/ErrorDetail.md)
 - [ErrorDetailCode](docs/ErrorDetailCode.md)
 - [InterfaceIpMapping](docs/InterfaceIpMapping.md)
 - [Labels](docs/Labels.md)
 - [Link](docs/Link.md)
 - [ListNotificationRulesResponse](docs/ListNotificationRulesResponse.md)
 - [Notification](docs/Notification.md)
 - [NotificationRule](docs/NotificationRule.md)
 - [NotificationRuleDetail](docs/NotificationRuleDetail.md)
 - [NotificationRules](docs/NotificationRules.md)
 - [ProxyAuthType](docs/ProxyAuthType.md)
 - [ProxyType](docs/ProxyType.md)
 - [SelfLinks](docs/SelfLinks.md)
 - [SimpleAgent](docs/SimpleAgent.md)
 - [SimpleEnterpriseAgent](docs/SimpleEnterpriseAgent.md)
 - [SimpleTest](docs/SimpleTest.md)
 - [TestInterval](docs/TestInterval.md)
 - [TestLinks](docs/TestLinks.md)
 - [TestSelfLink](docs/TestSelfLink.md)
 - [TestType](docs/TestType.md)
 - [UnauthorizedError](docs/UnauthorizedError.md)
 - [ValidationError](docs/ValidationError.md)
 - [ValidationErrorItem](docs/ValidationErrorItem.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