gitea-admin/thousandeyes-sdk-python
1
0
Fork 0
mirror of https://github.com/thousandeyes/thousandeyes-sdk-python.git synced 2025-12-06 07:55:31 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
73d1f2972c
thousandeyes-sdk-python/instant_tests/README.md

9.8 KiB
Raw Blame History

instant-tests

The Instant Tests API endpoint 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.2
  • Package version: 1.0.0
  • Generator version: 7.5.0
  • Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

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/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import 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 instant_tests

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:


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


# Enter a context with an instance of the API client
with instant_tests.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instant_tests.AgentToAgentApi(api_client)
    agent_to_agent_instant_test_request = instant_tests.AgentToAgentInstantTestRequest() # AgentToAgentInstantTestRequest | 
    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 = [instant_tests.Expand()] # List[Expand] | (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 agent-to-agent instant test
        api_response = api_instance.post_instant_test_agent_to_agent(agent_to_agent_instant_test_request, aid=aid, expand=expand)
        print("The response of AgentToAgentApi->post_instant_test_agent_to_agent:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AgentToAgentApi->post_instant_test_agent_to_agent: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
AgentToAgentApi post_instant_test_agent_to_agent POST /v7/tests/agent-to-agent/instant Create agent-to-agent instant test
AgentToServerApi post_instant_agent_to_server POST /v7/tests/agent-to-server/instant Create agent-to-server instant test
DNSSecurityApi post_instant_dns_sec POST /v7/tests/dnssec/instant Create DNS security instant test
DNSServerApi post_instant_dns_server POST /v7/tests/dns-server/instant Create DNS server instant test
DNSTraceApi post_instant_dns_trace POST /v7/tests/dns-trace/instant Create DNS trace instant test
FTPServerApi post_instant_ftp_server POST /v7/tests/ftp-server/instant Create FTP server instant test
HTTPPageLoadApi post_instant_http_page_load POST /v7/tests/page-load/instant Create HTTP page load instant test
HTTPServerApi post_instant_http_server POST /v7/tests/http-server/instant Create HTTP server instant test
RunApi post_instant_run POST /v7/tests/{testId}/run Run instant test
SIPServerApi post_instant_sip_server POST /v7/tests/sip-server/instant Create SIP server instant test
VoiceApi post_instant_voice POST /v7/tests/voice/instant Create voice instant test
WebTransactionApi post_instant_web_transactions POST /v7/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