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

# thousandeyes-sdk-endpoint-agents
Manage ThousandEyes Endpoint Agents using this API. 

For more information about Endpoint Agents, see [Endpoint Agents](https://docs.thousandeyes.com/product-documentation/global-vantage-points/endpoint-agents).

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 7.0.8
- 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-endpoint-agents\&subdirectory=thousandeyes-sdk-endpoint-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-endpoint-agents\&subdirectory=thousandeyes-sdk-endpoint-agents`)

Then import the package:
```python
import thousandeyes_sdk.endpoint_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.endpoint_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.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**](docs/AdministrativeEndpointsApi.md#get_endpoint_agents_connection_string) | **GET** /v7/endpoint/agents/connection-string | Get agent connection string
*ManageAgentsApi* | [**delete_endpoint_agent**](docs/ManageAgentsApi.md#delete_endpoint_agent) | **DELETE** /v7/endpoint/agents/{agentId} | Delete endpoint agent
*ManageAgentsApi* | [**disable_endpoint_agent**](docs/ManageAgentsApi.md#disable_endpoint_agent) | **POST** /v7/endpoint/agents/{agentId}/disable | Disable endpoint agent
*ManageAgentsApi* | [**enable_endpoint_agent**](docs/ManageAgentsApi.md#enable_endpoint_agent) | **POST** /v7/endpoint/agents/{agentId}/enable | Enable endpoint agent
*ManageAgentsApi* | [**filter_endpoint_agents**](docs/ManageAgentsApi.md#filter_endpoint_agents) | **POST** /v7/endpoint/agents/filter | Filter endpoint agents
*ManageAgentsApi* | [**get_endpoint_agent**](docs/ManageAgentsApi.md#get_endpoint_agent) | **GET** /v7/endpoint/agents/{agentId} | Retrieve endpoint agent
*ManageAgentsApi* | [**get_endpoint_agents**](docs/ManageAgentsApi.md#get_endpoint_agents) | **GET** /v7/endpoint/agents | List endpoint agents
*ManageAgentsApi* | [**update_endpoint_agent**](docs/ManageAgentsApi.md#update_endpoint_agent) | **PATCH** /v7/endpoint/agents/{agentId} | Update endpoint agent
*TransferApi* | [**transfer_endpoint_agent**](docs/TransferApi.md#transfer_endpoint_agent) | **POST** /v7/endpoint/agents/{agentId}/transfer | Transfer endpoint agent
*TransferApi* | [**transfer_endpoint_agents**](docs/TransferApi.md#transfer_endpoint_agents) | **POST** /v7/endpoint/agents/transfer/bulk | Bulk transfer agents


## Documentation For Models

 - [AddressProfile](docs/AddressProfile.md)
 - [AddressType](docs/AddressType.md)
 - [AgentLicenseType](docs/AgentLicenseType.md)
 - [AgentSearchFilters](docs/AgentSearchFilters.md)
 - [AgentSearchRequest](docs/AgentSearchRequest.md)
 - [AgentSearchSort](docs/AgentSearchSort.md)
 - [AgentSearchSortKey](docs/AgentSearchSortKey.md)
 - [AgentThresholdFilter](docs/AgentThresholdFilter.md)
 - [AgentThresholdFilters](docs/AgentThresholdFilters.md)
 - [AgentTransfer](docs/AgentTransfer.md)
 - [AgentTransferRequest](docs/AgentTransferRequest.md)
 - [AgentTransferStatus](docs/AgentTransferStatus.md)
 - [BrowserType](docs/BrowserType.md)
 - [BulkAgentTransferRequest](docs/BulkAgentTransferRequest.md)
 - [BulkAgentTransferResponse](docs/BulkAgentTransferResponse.md)
 - [ConditionalOperator](docs/ConditionalOperator.md)
 - [ConnectionString](docs/ConnectionString.md)
 - [EndpointAgent](docs/EndpointAgent.md)
 - [EndpointAgentLocation](docs/EndpointAgentLocation.md)
 - [EndpointAgentUpdate](docs/EndpointAgentUpdate.md)
 - [EndpointAgents](docs/EndpointAgents.md)
 - [EndpointAsnDetails](docs/EndpointAsnDetails.md)
 - [EndpointBrowserExtension](docs/EndpointBrowserExtension.md)
 - [EndpointClient](docs/EndpointClient.md)
 - [EndpointUserProfile](docs/EndpointUserProfile.md)
 - [EndpointVpnProfile](docs/EndpointVpnProfile.md)
 - [Error](docs/Error.md)
 - [EthernetProfile](docs/EthernetProfile.md)
 - [Expand](docs/Expand.md)
 - [FilterEndpointAgentsResponse](docs/FilterEndpointAgentsResponse.md)
 - [InterfaceHardwareType](docs/InterfaceHardwareType.md)
 - [InterfaceProfile](docs/InterfaceProfile.md)
 - [Link](docs/Link.md)
 - [ListEndpointAgentsResponse](docs/ListEndpointAgentsResponse.md)
 - [PaginationNextAndSelfLink](docs/PaginationNextAndSelfLink.md)
 - [PaginationNextLink](docs/PaginationNextLink.md)
 - [Platform](docs/Platform.md)
 - [SelfLinks](docs/SelfLinks.md)
 - [SortOrder](docs/SortOrder.md)
 - [Status](docs/Status.md)
 - [ThresholdFilterOperator](docs/ThresholdFilterOperator.md)
 - [UnauthorizedError](docs/UnauthorizedError.md)
 - [ValidationError](docs/ValidationError.md)
 - [ValidationErrorItem](docs/ValidationErrorItem.md)
 - [VpnType](docs/VpnType.md)
 - [WirelessProfile](docs/WirelessProfile.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