thousandeyes-sdk-python/endpoint/instant_tests_api

instant-tests-api

Overview

You can create and execute a new endpoint instant scheduled test within ThousandEyes using this API. The test parameters are specified in the POST data.

The following applies to the Endpoint Instant Scheduled Tests API:

• To initiate the creation and execution of an instant scheduled test, the user must possess the Edit endpoint tests permission.

• Upon successful creation of an instant scheduled test, the API responds with an HTTP/201 CREATED status code and return the test definition.

• It's important to note that the response does not include the results of the instant scheduled test. To retrieve test results, users can utilize the Endpoint Test Data endpoints. The URLs for these API test data endpoints are provided within the test definition output when an instant scheduled test is created.

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 instant_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 instant_tests_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import instant_tests_api
from instant_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 = instant_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 = instant_tests_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with instant_tests_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instant_tests_api.AgentToServerInstantScheduledTestApi(api_client)
    endpoint_agent_to_server_instant_test = instant_tests_api.EndpointAgentToServerInstantTest() # EndpointAgentToServerInstantTest | 
    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:
        # Run agent to server instant scheduled test
        api_response = api_instance.post_agent_to_server_instant_test(endpoint_agent_to_server_instant_test, aid=aid)
        print("The response of AgentToServerInstantScheduledTestApi->post_agent_to_server_instant_test:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AgentToServerInstantScheduledTestApi->post_agent_to_server_instant_test: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AgentToServerInstantScheduledTestApi	post_agent_to_server_instant_test	POST /v7/endpoint/tests/scheduled-tests/agent-to-server/instant	Run agent to server instant scheduled test
HttpServerInstantScheduledTestApi	post_http_server_instant_test	POST /v7/endpoint/tests/scheduled-tests/http-server/instant	Run http server instant scheduled test
RunExistingTestApi	post_endpoint_instant_run	POST /v7/endpoint/tests/scheduled-tests/{testId}/run	Run endpoint instant scheduled test

Documentation For Models

• AccountGroupId
• AgentLabelsSelectorType
• AllAgentsSelectorType
• EndpointAgentLabelsSelectorConfig
• EndpointAgentSelectorConfig
• EndpointAgentToServerInstantTest
• EndpointAgentToServerTest
• EndpointAgentToServerType
• EndpointAllAgentsSelectorConfig
• EndpointHttpServerBaseTest
• EndpointHttpServerInstantTest
• EndpointHttpServerTest
• EndpointHttpServerType
• EndpointInstantTest
• EndpointScheduledTestType
• EndpointSpecificAgentsSelectorConfig
• EndpointTest
• EndpointTestAgentSelectorType
• EndpointTestAid
• EndpointTestAuthType
• EndpointTestLinks
• EndpointTestLinksSelf
• EndpointTestLinksTestResults
• EndpointTestProtocol
• Error
• Link
• SpecificAgentsSelectorType
• TestInterval
• TestProbeMode
• TestSslVersionId
• UnauthorizedError

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: Bearer authentication

Author