Skip to content

Latest commit

 

History

History
237 lines (194 loc) · 22.6 KB

README.md

File metadata and controls

237 lines (194 loc) · 22.6 KB

thousandeyes-sdk-instant-tests

The Instant Tests API operations lets you create and run new instant tests. You will need to be a regular user or have the following permissions:

  • API Access
  • View tests

The response does not include the immediate test results. Use the Test Results endpoints to get test results after creating and executing an instant test. You can find the URLs for these endpoints in the _links section of the test definition that is returned when you create the instant test.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 7.0.34
  • 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-instant-tests

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

Then import the package:

import thousandeyes_sdk.instant_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.instant_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.instant_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.instant_tests.APIInstantTestsApi(api_client)
    api_instant_test_request = thousandeyes_sdk.instant_tests.ApiInstantTestRequest() # ApiInstantTestRequest | 
    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)
    expand = [thousandeyes_sdk.instant_tests.ExpandInstantTestOptions()] # List[ExpandInstantTestOptions] | (Optional) Indicates if the test sub-resources should be expanded. Defaults to no expansion. To expand the `agents` sub-resource, use the query `?expand=agent`. (optional)

    try:
        # Create API instant test
        api_response = api_instance.create_api_instant_test(api_instant_test_request, aid=aid, expand=expand)
        print("The response of APIInstantTestsApi->create_api_instant_test:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling APIInstantTestsApi->create_api_instant_test: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
APIInstantTestsApi create_api_instant_test POST /tests/api/instant Create API instant test
AgentToAgentInstantTestsApi create_agent_to_agent_instant_test POST /tests/agent-to-agent/instant Create agent-to-agent instant test
AgentToServerInstantTestsApi create_agent_to_server_instant_test POST /tests/agent-to-server/instant Create agent-to-server instant test
DNSSECInstantTestsApi create_dns_sec_instant_test POST /tests/dnssec/instant Create DNSSEC instant test
DNSServerInstantTestsApi create_dns_server_instant_test POST /tests/dns-server/instant Create DNS server instant test
DNSTraceInstantTestsApi create_dns_trace_instant_test POST /tests/dns-trace/instant Create DNS trace instant test
FTPServerInstantTestsApi create_ftp_server_instant_test POST /tests/ftp-server/instant Create FTP server instant test
HTTPPageLoadInstantTestsApi create_page_load_instant_test POST /tests/page-load/instant Create HTTP page load instant test
HTTPServerInstantTestsApi create_http_server_instant_test POST /tests/http-server/instant Create HTTP server instant test
InstantTestsApi run_instant_test POST /tests/{testId}/run Run instant test
SIPServerInstantTestsApi create_sip_server_instant_test POST /tests/sip-server/instant Create SIP server instant test
VoiceInstantTestsApi create_voice_instant_test POST /tests/voice/instant Create voice instant test
WebTransactionInstantTestsApi create_web_transaction_instant_test POST /tests/web-transactions/instant Create web transactions instant test

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

  • Type: Bearer authentication

Author

ThousandEyes API Team