mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2026-03-22 02:56:51 +00:00
184 lines
8.8 KiB
Markdown
184 lines
8.8 KiB
Markdown
# tests-api
|
|
|
|
## Overview
|
|
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.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 tests_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 tests_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 tests_api
|
|
from tests_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 = tests_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 = tests_api.Configuration(
|
|
access_token = os.environ["BEARER_TOKEN"]
|
|
)
|
|
|
|
|
|
# Enter a context with an instance of the API client
|
|
with tests_api.ApiClient(configuration) as api_client:
|
|
# Create an instance of the API class
|
|
api_instance = tests_api.DynamicTestsAgentToServerApi(api_client)
|
|
test_id = '584739201' # str | Unique ID of endpoint test.
|
|
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 endpoint dynamic test
|
|
api_response = api_instance.get_dynamic_test_detail(test_id, aid=aid)
|
|
print("The response of DynamicTestsAgentToServerApi->get_dynamic_test_detail:\n")
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling DynamicTestsAgentToServerApi->get_dynamic_test_detail: %s\n" % e)
|
|
|
|
```
|
|
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to *https://api.thousandeyes.com*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*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
|
|
*ListEndpointScheduledTestsApi* | [**get_endpoint_tests_list**](docs/ListEndpointScheduledTestsApi.md#get_endpoint_tests_list) | **GET** /v7/endpoint/tests/scheduled-tests | List endpoint scheduled tests
|
|
*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_toserver_tests_list**](docs/ScheduledTestsAgentToServerApi.md#get_endpoint_agent_toserver_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
|
|
*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
|
|
|
|
|
|
## Documentation For Models
|
|
|
|
- [AccountGroupId](docs/AccountGroupId.md)
|
|
- [AgentLabelsSelectorType](docs/AgentLabelsSelectorType.md)
|
|
- [AllAgentsSelectorType](docs/AllAgentsSelectorType.md)
|
|
- [DynamicTest](docs/DynamicTest.md)
|
|
- [DynamicTestApplication](docs/DynamicTestApplication.md)
|
|
- [DynamicTestLinks](docs/DynamicTestLinks.md)
|
|
- [DynamicTestLinksSelf](docs/DynamicTestLinksSelf.md)
|
|
- [DynamicTestLinksTestResults](docs/DynamicTestLinksTestResults.md)
|
|
- [DynamicTestRequest](docs/DynamicTestRequest.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)
|
|
- [EndpointAgentToServerType](docs/EndpointAgentToServerType.md)
|
|
- [EndpointAllAgentsSelectorConfig](docs/EndpointAllAgentsSelectorConfig.md)
|
|
- [EndpointHttpServerBaseTest](docs/EndpointHttpServerBaseTest.md)
|
|
- [EndpointHttpServerInstantTest](docs/EndpointHttpServerInstantTest.md)
|
|
- [EndpointHttpServerTest](docs/EndpointHttpServerTest.md)
|
|
- [EndpointHttpServerTestRequest](docs/EndpointHttpServerTestRequest.md)
|
|
- [EndpointHttpServerTests](docs/EndpointHttpServerTests.md)
|
|
- [EndpointHttpServerType](docs/EndpointHttpServerType.md)
|
|
- [EndpointInstantTest](docs/EndpointInstantTest.md)
|
|
- [EndpointScheduledTestType](docs/EndpointScheduledTestType.md)
|
|
- [EndpointSpecificAgentsSelectorConfig](docs/EndpointSpecificAgentsSelectorConfig.md)
|
|
- [EndpointTest](docs/EndpointTest.md)
|
|
- [EndpointTestAgentSelectorType](docs/EndpointTestAgentSelectorType.md)
|
|
- [EndpointTestAid](docs/EndpointTestAid.md)
|
|
- [EndpointTestAuthType](docs/EndpointTestAuthType.md)
|
|
- [EndpointTestLinks](docs/EndpointTestLinks.md)
|
|
- [EndpointTestLinksSelf](docs/EndpointTestLinksSelf.md)
|
|
- [EndpointTestLinksTestResults](docs/EndpointTestLinksTestResults.md)
|
|
- [EndpointTestProtocol](docs/EndpointTestProtocol.md)
|
|
- [EndpointTests](docs/EndpointTests.md)
|
|
- [Error](docs/Error.md)
|
|
- [GetDynamicTestDetail200Response](docs/GetDynamicTestDetail200Response.md)
|
|
- [GetDynamicTestsList200Response](docs/GetDynamicTestsList200Response.md)
|
|
- [GetEndpointAgentToserverTestsList200Response](docs/GetEndpointAgentToserverTestsList200Response.md)
|
|
- [GetEndpointHttpserverTestDetail200Response](docs/GetEndpointHttpserverTestDetail200Response.md)
|
|
- [GetEndpointHttpserverTestsList200Response](docs/GetEndpointHttpserverTestsList200Response.md)
|
|
- [GetEndpointTestsList200Response](docs/GetEndpointTestsList200Response.md)
|
|
- [Link](docs/Link.md)
|
|
- [PostEndpointAgentToServerTest201Response](docs/PostEndpointAgentToServerTest201Response.md)
|
|
- [SelfLinks](docs/SelfLinks.md)
|
|
- [SelfLinksLinks](docs/SelfLinksLinks.md)
|
|
- [SpecificAgentsSelectorType](docs/SpecificAgentsSelectorType.md)
|
|
- [TestInterval](docs/TestInterval.md)
|
|
- [TestProbeMode](docs/TestProbeMode.md)
|
|
- [TestSslVersionId](docs/TestSslVersionId.md)
|
|
- [UnauthorizedError](docs/UnauthorizedError.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
|
|
|
|
|
|
|
|
|