# thousandeyes-sdk-endpoint-tests

Manage endpoint agent dynamic and scheduled tests using the Endpoint Tests API.


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

- API version: 7.0.4
- Package version: 1.0.0
- 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 git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

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

### 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_tests
```

### 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.endpoint_tests
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.endpoint_tests.DynamicTestsAgentToServerApi(api_client)
    test_id = '584739201' # str | Unique ID of endpoint test.
    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:
        # Delete agent to server dynamic test
        api_instance.delete_endpoint_dynamic_test(test_id, aid=aid)
    except ApiException as e:
        print("Exception when calling DynamicTestsAgentToServerApi->delete_endpoint_dynamic_test: %s\n" % e)

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DynamicTestsAgentToServerApi* | [**delete_endpoint_dynamic_test**](docs/DynamicTestsAgentToServerApi.md#delete_endpoint_dynamic_test) | **DELETE** /v7/endpoint/tests/dynamic-tests/agent-to-server/{testId} | Delete agent to server dynamic test
*DynamicTestsAgentToServerApi* | [**get_dynamic_test_detail**](docs/DynamicTestsAgentToServerApi.md#get_dynamic_test_detail) | **GET** /v7/endpoint/tests/dynamic-tests/agent-to-server/{testId} | Retrieve endpoint dynamic test
*DynamicTestsAgentToServerApi* | [**get_dynamic_tests_list**](docs/DynamicTestsAgentToServerApi.md#get_dynamic_tests_list) | **GET** /v7/endpoint/tests/dynamic-tests/agent-to-server | List endpoint dynamic tests
*DynamicTestsAgentToServerApi* | [**post_dynamic_test**](docs/DynamicTestsAgentToServerApi.md#post_dynamic_test) | **POST** /v7/endpoint/tests/dynamic-tests/agent-to-server | Create endpoint dynamic test
*DynamicTestsAgentToServerApi* | [**update_endpoint_dynamic_test_detail**](docs/DynamicTestsAgentToServerApi.md#update_endpoint_dynamic_test_detail) | **PATCH** /v7/endpoint/tests/dynamic-tests/agent-to-server/{testId} | Update agent to server dynamic test
*ListEndpointScheduledTestsApi* | [**get_endpoint_tests_list**](docs/ListEndpointScheduledTestsApi.md#get_endpoint_tests_list) | **GET** /v7/endpoint/tests/scheduled-tests | List endpoint scheduled tests
*ScheduledTestsAgentToServerApi* | [**delete_endpoint_agent_to_server_test**](docs/ScheduledTestsAgentToServerApi.md#delete_endpoint_agent_to_server_test) | **DELETE** /v7/endpoint/tests/scheduled-tests/agent-to-server/{testId} | Delete agent to server scheduled test
*ScheduledTestsAgentToServerApi* | [**get_endpoint_agent_to_server_detail**](docs/ScheduledTestsAgentToServerApi.md#get_endpoint_agent_to_server_detail) | **GET** /v7/endpoint/tests/scheduled-tests/agent-to-server/{testId} | Retrieve agent to server endpoint scheduled test
*ScheduledTestsAgentToServerApi* | [**get_endpoint_agent_to_server_tests_list**](docs/ScheduledTestsAgentToServerApi.md#get_endpoint_agent_to_server_tests_list) | **GET** /v7/endpoint/tests/scheduled-tests/agent-to-server | List agent to server endpoint scheduled tests
*ScheduledTestsAgentToServerApi* | [**post_endpoint_agent_to_server_test**](docs/ScheduledTestsAgentToServerApi.md#post_endpoint_agent_to_server_test) | **POST** /v7/endpoint/tests/scheduled-tests/agent-to-server | Creates agent to server endpoint scheduled test
*ScheduledTestsAgentToServerApi* | [**update_endpoint_agent_to_server_detail**](docs/ScheduledTestsAgentToServerApi.md#update_endpoint_agent_to_server_detail) | **PATCH** /v7/endpoint/tests/scheduled-tests/agent-to-server/{testId} | Update agent to server endpoint scheduled test
*ScheduledTestsHTTPServerApi* | [**delete_endpoint_http_server_test**](docs/ScheduledTestsHTTPServerApi.md#delete_endpoint_http_server_test) | **DELETE** /v7/endpoint/tests/scheduled-tests/http-server/{testId} | Delete HTTP server scheduled test
*ScheduledTestsHTTPServerApi* | [**get_endpoint_httpserver_test_detail**](docs/ScheduledTestsHTTPServerApi.md#get_endpoint_httpserver_test_detail) | **GET** /v7/endpoint/tests/scheduled-tests/http-server/{testId} | Retrieves HTTP server endpoint scheduled test
*ScheduledTestsHTTPServerApi* | [**get_endpoint_httpserver_tests_list**](docs/ScheduledTestsHTTPServerApi.md#get_endpoint_httpserver_tests_list) | **GET** /v7/endpoint/tests/scheduled-tests/http-server | List HTTP server endpoint scheduled tests
*ScheduledTestsHTTPServerApi* | [**post_endpoint_httpserver_test**](docs/ScheduledTestsHTTPServerApi.md#post_endpoint_httpserver_test) | **POST** /v7/endpoint/tests/scheduled-tests/http-server | Create HTTP server endpoint scheduled test
*ScheduledTestsHTTPServerApi* | [**update_endpoint_http_server_detail**](docs/ScheduledTestsHTTPServerApi.md#update_endpoint_http_server_detail) | **PATCH** /v7/endpoint/tests/scheduled-tests/http-server/{testId} | Update HTTP server endpoint scheduled test


## Documentation For Models

 - [AlertDirection](docs/AlertDirection.md)
 - [AlertRoundsViolationMode](docs/AlertRoundsViolationMode.md)
 - [AlertRule](docs/AlertRule.md)
 - [AlertType](docs/AlertType.md)
 - [DynamicTest](docs/DynamicTest.md)
 - [DynamicTestLinks](docs/DynamicTestLinks.md)
 - [DynamicTestRequest](docs/DynamicTestRequest.md)
 - [DynamicTestSelfLink](docs/DynamicTestSelfLink.md)
 - [DynamicTests](docs/DynamicTests.md)
 - [EndpointAgentLabelsSelectorConfig](docs/EndpointAgentLabelsSelectorConfig.md)
 - [EndpointAgentSelectorConfig](docs/EndpointAgentSelectorConfig.md)
 - [EndpointAgentToServerInstantTest](docs/EndpointAgentToServerInstantTest.md)
 - [EndpointAgentToServerTest](docs/EndpointAgentToServerTest.md)
 - [EndpointAgentToServerTestRequest](docs/EndpointAgentToServerTestRequest.md)
 - [EndpointAgentToServerTests](docs/EndpointAgentToServerTests.md)
 - [EndpointAllAgentsSelectorConfig](docs/EndpointAllAgentsSelectorConfig.md)
 - [EndpointDynamicTestUpdate](docs/EndpointDynamicTestUpdate.md)
 - [EndpointHttpServerBaseTest](docs/EndpointHttpServerBaseTest.md)
 - [EndpointHttpServerInstantTest](docs/EndpointHttpServerInstantTest.md)
 - [EndpointHttpServerTest](docs/EndpointHttpServerTest.md)
 - [EndpointHttpServerTestRequest](docs/EndpointHttpServerTestRequest.md)
 - [EndpointHttpServerTests](docs/EndpointHttpServerTests.md)
 - [EndpointHttpTestUpdate](docs/EndpointHttpTestUpdate.md)
 - [EndpointInstantTest](docs/EndpointInstantTest.md)
 - [EndpointNetworkTestUpdate](docs/EndpointNetworkTestUpdate.md)
 - [EndpointScheduledTestType](docs/EndpointScheduledTestType.md)
 - [EndpointSpecificAgentsSelectorConfig](docs/EndpointSpecificAgentsSelectorConfig.md)
 - [EndpointTest](docs/EndpointTest.md)
 - [EndpointTestAgentSelectorType](docs/EndpointTestAgentSelectorType.md)
 - [EndpointTestAuthType](docs/EndpointTestAuthType.md)
 - [EndpointTestLinks](docs/EndpointTestLinks.md)
 - [EndpointTestProtocol](docs/EndpointTestProtocol.md)
 - [EndpointTestSelfLink](docs/EndpointTestSelfLink.md)
 - [EndpointTests](docs/EndpointTests.md)
 - [Error](docs/Error.md)
 - [Link](docs/Link.md)
 - [SelfLinks](docs/SelfLinks.md)
 - [Severity](docs/Severity.md)
 - [TestInterval](docs/TestInterval.md)
 - [TestLabel](docs/TestLabel.md)
 - [TestProbeMode](docs/TestProbeMode.md)
 - [TestProbeModeResponse](docs/TestProbeModeResponse.md)
 - [TestSslVersionId](docs/TestSslVersionId.md)
 - [TestUpdate](docs/TestUpdate.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




