thousandeyes-sdk-python/endpoint/tests_api

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 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:

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:

import tests_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import tests_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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	GET /v7/endpoint/tests/dynamic-tests/agent-to-server/{testId}	Retrieve endpoint dynamic test
DynamicTestsAgentToServerApi	get_dynamic_tests_list	GET /v7/endpoint/tests/dynamic-tests/agent-to-server	List endpoint dynamic tests
DynamicTestsAgentToServerApi	post_dynamic_test	POST /v7/endpoint/tests/dynamic-tests/agent-to-server	Create endpoint dynamic test
ListEndpointScheduledTestsApi	get_endpoint_tests_list	GET /v7/endpoint/tests/scheduled-tests	List endpoint scheduled tests
ScheduledTestsAgentToServerApi	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	GET /v7/endpoint/tests/scheduled-tests/agent-to-server	List agent to server endpoint scheduled tests
ScheduledTestsAgentToServerApi	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	GET /v7/endpoint/tests/scheduled-tests/http-server/{testId}	Retrieves HTTP server endpoint scheduled test
ScheduledTestsHTTPServerApi	get_endpoint_httpserver_tests_list	GET /v7/endpoint/tests/scheduled-tests/http-server	List HTTP server endpoint scheduled tests
ScheduledTestsHTTPServerApi	post_endpoint_httpserver_test	POST /v7/endpoint/tests/scheduled-tests/http-server	Create HTTP server endpoint scheduled test

Documentation For Models

• AccountGroupId
• AgentLabelsSelectorType
• AllAgentsSelectorType
• DynamicTest
• DynamicTestApplication
• DynamicTestLinks
• DynamicTestLinksSelf
• DynamicTestLinksTestResults
• DynamicTestRequest
• DynamicTests
• EndpointAgentLabelsSelectorConfig
• EndpointAgentSelectorConfig
• EndpointAgentToServerInstantTest
• EndpointAgentToServerTest
• EndpointAgentToServerTestRequest
• EndpointAgentToServerTests
• EndpointAgentToServerType
• EndpointAllAgentsSelectorConfig
• EndpointHttpServerBaseTest
• EndpointHttpServerInstantTest
• EndpointHttpServerTest
• EndpointHttpServerTestRequest
• EndpointHttpServerTests
• EndpointHttpServerType
• EndpointInstantTest
• EndpointScheduledTestType
• EndpointSpecificAgentsSelectorConfig
• EndpointTest
• EndpointTestAgentSelectorType
• EndpointTestAid
• EndpointTestAuthType
• EndpointTestLinks
• EndpointTestLinksSelf
• EndpointTestLinksTestResults
• EndpointTestProtocol
• EndpointTests
• Error
• GetDynamicTestDetail200Response
• GetDynamicTestsList200Response
• GetEndpointAgentToserverTestsList200Response
• GetEndpointHttpserverTestDetail200Response
• GetEndpointHttpserverTestsList200Response
• GetEndpointTestsList200Response
• Link
• PostEndpointAgentToServerTest201Response
• SelfLinks
• SelfLinksLinks
• SpecificAgentsSelectorType
• TestInterval
• TestProbeMode
• TestSslVersionId
• UnauthorizedError

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: Bearer authentication

Author