Skip to content

Latest commit

 

History

History
179 lines (136 loc) · 15.8 KB

README.md

File metadata and controls

179 lines (136 loc) · 15.8 KB
Raw

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

  • API version: 7.0.25
  • Generator version: 7.6.0
  • Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

Requirements.

Python 3.8+

Installation & Usage

pip install

Install directly via PyPi:

pip install thousandeyes-sdk-endpoint-tests

(you may need to run pip with root permission: sudo pip install thousandeyes-sdk-endpoint-tests)

Then import the package:

import thousandeyes_sdk.endpoint_tests

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 thousandeyes_sdk.endpoint_tests

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import thousandeyes_sdk.core
import thousandeyes_sdk.endpoint_tests
from thousandeyes_sdk.core.exceptions import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.thousandeyes.com/v7
# See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.Configuration(
    host = "https://api.thousandeyes.com/v7"
)

# 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_tests.AgentToServerEndpointDynamicTestsApi(api_client)
    dynamic_test_request = thousandeyes_sdk.endpoint_tests.DynamicTestRequest() # DynamicTestRequest | 
    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:
        # Create endpoint dynamic test
        api_response = api_instance.create_agent_to_server_endpoint_dynamic_test(dynamic_test_request, aid=aid)
        print("The response of AgentToServerEndpointDynamicTestsApi->create_agent_to_server_endpoint_dynamic_test:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AgentToServerEndpointDynamicTestsApi->create_agent_to_server_endpoint_dynamic_test: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
AgentToServerEndpointDynamicTestsApi create_agent_to_server_endpoint_dynamic_test POST /endpoint/tests/dynamic-tests/agent-to-server Create endpoint dynamic test
AgentToServerEndpointDynamicTestsApi delete_agent_to_server_endpoint_dynamic_test DELETE /endpoint/tests/dynamic-tests/agent-to-server/{testId} Delete agent to server dynamic test
AgentToServerEndpointDynamicTestsApi get_agent_to_server_endpoint_dynamic_test GET /endpoint/tests/dynamic-tests/agent-to-server/{testId} Retrieve endpoint dynamic test
AgentToServerEndpointDynamicTestsApi get_agent_to_server_endpoint_dynamic_tests GET /endpoint/tests/dynamic-tests/agent-to-server List endpoint dynamic tests
AgentToServerEndpointDynamicTestsApi update_agent_to_server_endpoint_dynamic_test PATCH /endpoint/tests/dynamic-tests/agent-to-server/{testId} Update agent to server dynamic test
AgentToServerEndpointScheduledTestsApi create_agent_to_server_endpoint_scheduled_test POST /endpoint/tests/scheduled-tests/agent-to-server Creates agent to server endpoint scheduled test
AgentToServerEndpointScheduledTestsApi delete_agent_to_server_endpoint_scheduled_test DELETE /endpoint/tests/scheduled-tests/agent-to-server/{testId} Delete agent to server scheduled test
AgentToServerEndpointScheduledTestsApi get_agent_to_server_endpoint_scheduled_test GET /endpoint/tests/scheduled-tests/agent-to-server/{testId} Retrieve agent to server endpoint scheduled test
AgentToServerEndpointScheduledTestsApi get_agent_to_server_endpoint_scheduled_tests GET /endpoint/tests/scheduled-tests/agent-to-server List agent to server endpoint scheduled tests
AgentToServerEndpointScheduledTestsApi update_agent_to_server_endpoint_scheduled_test PATCH /endpoint/tests/scheduled-tests/agent-to-server/{testId} Update agent to server endpoint scheduled test
EndpointScheduledTestsApi get_endpoint_scheduled_tests GET /endpoint/tests/scheduled-tests List endpoint scheduled tests
HTTPServerEndpointScheduledTestsApi create_http_server_endpoint_scheduled_test POST /endpoint/tests/scheduled-tests/http-server Create HTTP server endpoint scheduled test
HTTPServerEndpointScheduledTestsApi delete_http_server_endpoint_scheduled_test DELETE /endpoint/tests/scheduled-tests/http-server/{testId} Delete HTTP server scheduled test
HTTPServerEndpointScheduledTestsApi get_http_server_endpoint_scheduled_test GET /endpoint/tests/scheduled-tests/http-server/{testId} Retrieves HTTP server endpoint scheduled test
HTTPServerEndpointScheduledTestsApi get_http_server_endpoint_scheduled_tests GET /endpoint/tests/scheduled-tests/http-server List HTTP server endpoint scheduled tests
HTTPServerEndpointScheduledTestsApi update_http_server_endpoint_scheduled_test PATCH /endpoint/tests/scheduled-tests/http-server/{testId} Update HTTP server endpoint scheduled test

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

  • Type: Bearer authentication

Author

ThousandEyes API Team