thousandeyes-sdk-python/thousandeyes-sdk-tests/README.md

thousandeyes-sdk-tests

This API supports listing, creating, editing, and deleting Cloud and Enterprise Agent (CEA) based tests.

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

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

Requirements.

Python 3.8+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install -e git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git#egg=thousandeyes-sdk-tests\&subdirectory=thousandeyes-sdk-tests

(you may need to run pip with root permission: sudo pip install -e git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git#egg=thousandeyes-sdk-tests\&subdirectory=thousandeyes-sdk-tests)

Then import the package:

import thousandeyes_sdk.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.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.tests
from thousandeyes_sdk.core.exceptions 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 = thousandeyes_sdk.core.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 = 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.tests.APIApi(api_client)
    update_api_test = thousandeyes_sdk.tests.UpdateApiTest() # UpdateApiTest | 
    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.tests.Expand()] # List[Expand] | Optional parameter on whether or not to expand the test sub-resources. By default no expansion is going to take place if the query parameter is not present. If the user wishes to expand the `agents` sub-resource, they need to pass the `?expand=agent` query. (optional)

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

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
APIApi	create_api_test	POST /v7/tests/api	Create API test
APIApi	delete_api_test	DELETE /v7/tests/api/{testId}	Delete API test
APIApi	get_api_test	GET /v7/tests/api/{testId}	Get API test
APIApi	get_api_tests	GET /v7/tests/api	List API tests
APIApi	update_api_test	PUT /v7/tests/api/{testId}	Update API test
AgentToAgentApi	create_agent_to_agent_test	POST /v7/tests/agent-to-agent	Create Agent to Agent test
AgentToAgentApi	delete_agent_to_agent_test	DELETE /v7/tests/agent-to-agent/{testId}	Delete Agent to Agent test
AgentToAgentApi	get_agent_to_agent_test	GET /v7/tests/agent-to-agent/{testId}	Get Agent to Agent test
AgentToAgentApi	get_agent_to_agent_tests	GET /v7/tests/agent-to-agent	List Agent to Agent tests
AgentToAgentApi	update_agent_to_agent_test	PUT /v7/tests/agent-to-agent/{testId}	Update Agent to Agent test
AgentToServerApi	create_agent_to_server_test	POST /v7/tests/agent-to-server	Create Agent to Server test
AgentToServerApi	delete_agent_to_server_test	DELETE /v7/tests/agent-to-server/{testId}	Delete Agent to Server test
AgentToServerApi	get_agent_to_server_test	GET /v7/tests/agent-to-server/{testId}	Get Agent to Server test
AgentToServerApi	get_agent_to_server_tests	GET /v7/tests/agent-to-server	List Agent to Server tests
AgentToServerApi	update_agent_to_server_test	PUT /v7/tests/agent-to-server/{testId}	Update Agent to Server test
AllTestTypesApi	get_tests	GET /v7/tests	List configured tests
BGPApi	create_bgp_test	POST /v7/tests/bgp	Create BGP test
BGPApi	delete_bgp_test	DELETE /v7/tests/bgp/{testId}	Delete BGP test
BGPApi	get_bgp_test	GET /v7/tests/bgp/{testId}	Get BGP test
BGPApi	get_bgp_tests	GET /v7/tests/bgp	List BGP tests
BGPApi	update_bgp_test	PUT /v7/tests/bgp/{testId}	Update BGP test
DNSSECApi	create_dns_sec_test	POST /v7/tests/dnssec	Create DNSSEC test
DNSSECApi	delete_dns_sec_test	DELETE /v7/tests/dnssec/{testId}	Delete DNSSEC test
DNSSECApi	get_dns_sec_test	GET /v7/tests/dnssec/{testId}	Get DNSSEC test
DNSSECApi	get_dns_sec_tests	GET /v7/tests/dnssec	List DNSSEC tests
DNSSECApi	update_dns_sec_test	PUT /v7/tests/dnssec/{testId}	Update DNSSEC test
DNSServerApi	create_dns_server_test	POST /v7/tests/dns-server	Create DNS Server test
DNSServerApi	delete_dns_server_test	DELETE /v7/tests/dns-server/{testId}	Delete DNS Server test
DNSServerApi	get_dns_server_test	GET /v7/tests/dns-server/{testId}	Get DNS Server test
DNSServerApi	get_dns_server_tests	GET /v7/tests/dns-server	List DNS Server tests
DNSServerApi	update_dns_server_test	PUT /v7/tests/dns-server/{testId}	Update DNS Server test
DNSTraceApi	create_dns_trace_test	POST /v7/tests/dns-trace	Create DNS Trace test
DNSTraceApi	delete_dns_trace_test	DELETE /v7/tests/dns-trace/{testId}	Delete DNS Trace test
DNSTraceApi	get_dns_trace_test	GET /v7/tests/dns-trace/{testId}	Get DNS Trace test
DNSTraceApi	get_dns_trace_tests	GET /v7/tests/dns-trace	List DNS Trace tests
DNSTraceApi	update_dns_trace_test	PUT /v7/tests/dns-trace/{testId}	Update DNS Trace test
FTPServerApi	create_ftp_server_test	POST /v7/tests/ftp-server	Create FTP Server test
FTPServerApi	delete_ftp_server_test	DELETE /v7/tests/ftp-server/{testId}	Delete FTP Server test
FTPServerApi	get_ftp_server_test	GET /v7/tests/ftp-server/{testId}	Get FTP Server test
FTPServerApi	get_ftp_server_tests	GET /v7/tests/ftp-server	List FTP Server tests
FTPServerApi	update_ftp_server_test	PUT /v7/tests/ftp-server/{testId}	Update FTP Server test
HTTPServerApi	create_http_server_test	POST /v7/tests/http-server	Create HTTP Server test
HTTPServerApi	delete_http_server_test	DELETE /v7/tests/http-server/{testId}	Delete HTTP Server test
HTTPServerApi	get_http_server_test	GET /v7/tests/http-server/{testId}	Get HTTP Server test
HTTPServerApi	get_http_server_tests	GET /v7/tests/http-server	List HTTP Server tests
HTTPServerApi	update_http_server_test	PUT /v7/tests/http-server/{testId}	Update HTTP Server test
PageLoadApi	create_page_load_test	POST /v7/tests/page-load	Create Page Load test
PageLoadApi	delete_page_load_test	DELETE /v7/tests/page-load/{testId}	Delete Page Load test
PageLoadApi	get_page_load_test	GET /v7/tests/page-load/{testId}	Get Page Load test
PageLoadApi	get_page_load_tests	GET /v7/tests/page-load	List Page Load tests
PageLoadApi	update_page_load_test	PUT /v7/tests/page-load/{testId}	Update Page Load test
PathVisualizationInterfaceGroupsApi	create_path_vis_interface_groups	POST /v7/network/path-vis/interface-groups	Create interface group for path visualization
PathVisualizationInterfaceGroupsApi	delete_path_vis_interface_group	DELETE /v7/network/path-vis/interface-groups/{interfaceGroupId}	Delete interface group
PathVisualizationInterfaceGroupsApi	get_path_vis_interface_groups	GET /v7/network/path-vis/interface-groups	List interface groups for path visualization
PathVisualizationInterfaceGroupsApi	update_path_vis_interface_group	PUT /v7/network/path-vis/interface-groups/{interfaceGroupId}	Update interface group
SIPServerApi	create_sip_server_test	POST /v7/tests/sip-server	Create SIP Server test
SIPServerApi	delete_sip_server_test	DELETE /v7/tests/sip-server/{testId}	Delete SIP Server test
SIPServerApi	get_sip_server_test	GET /v7/tests/sip-server/{testId}	Get SIP Server test
SIPServerApi	get_sip_server_tests	GET /v7/tests/sip-server	List SIP Server tests
SIPServerApi	update_sip_server_test	PUT /v7/tests/sip-server/{testId}	Update SIP Server test
VoiceApi	create_voice_test	POST /v7/tests/voice	Create Voice test
VoiceApi	delete_voice_test	DELETE /v7/tests/voice/{testId}	Delete Voice test
VoiceApi	get_voice_test	GET /v7/tests/voice/{testId}	Get Voice test
VoiceApi	get_voice_tests	GET /v7/tests/voice	List Voice tests
VoiceApi	update_voice_test	PUT /v7/tests/voice/{testId}	Update Voice test
WebTransactionApi	create_web_transactions_test	POST /v7/tests/web-transactions	Create Web Transactions test
WebTransactionApi	delete_web_transactions_test	DELETE /v7/tests/web-transactions/{testId}	Delete Web Transactions test
WebTransactionApi	get_web_transactions_test	GET /v7/tests/web-transactions/{testId}	Get Web Transactions test
WebTransactionApi	get_web_transactions_tests	GET /v7/tests/web-transactions	List Web Transactions tests
WebTransactionApi	update_web_transactions_test	PUT /v7/tests/web-transactions/{testId}	Update Web Transactions test

Documentation For Models

• Agent
• AgentBase
• AgentRequest
• AgentToAgentInstantTest
• AgentToAgentProperties
• AgentToAgentTest
• AgentToAgentTestProtocol
• AgentToAgentTests
• AgentToServerInstantTest
• AgentToServerProperties
• AgentToServerTest
• AgentToServerTests
• AlertDirection
• AlertRoundsViolationMode
• AlertRule
• AlertType
• ApiInstantTest
• ApiPredefinedVariable
• ApiProperties
• ApiRequest
• ApiRequestAssertion
• ApiRequestAssertionName
• ApiRequestAssertionOperator
• ApiRequestAuthType
• ApiRequestHeader
• ApiRequestMethod
• ApiRequestVariable
• ApiTest
• ApiTests
• BaseBgpTest
• BaseRequest
• BaseTest
• BgpTest
• BgpTests
• CloudEnterpriseAgentType
• DnsQueryClass
• DnsSecInstantTest
• DnsSecProperties
• DnsSecTest
• DnsSecTests
• DnsServerInstantTest
• DnsServerProperties
• DnsServerTest
• DnsServerTests
• DnsServersRequest
• DnsTraceInstantTest
• DnsTraceProperties
• DnsTraceTest
• DnsTraceTests
• Error
• Expand
• FtpServerInstantTest
• FtpServerProperties
• FtpServerRequestType
• FtpServerTest
• FtpServerTests
• HttpServerInstantTest
• HttpServerProperties
• HttpServerTest
• HttpServerTests
• InstantTest
• InterfaceGroup
• InterfaceGroups
• Link
• Monitor
• MonitorType
• MonitorsRequest
• PageLoadInstantTest
• PageLoadProperties
• PageLoadTest
• PageLoadTests
• SelfLinks
• Severity
• SharedWithAccount
• SimpleAgent
• SimpleTest
• SipServerInstantTest
• SipServerInstantTestRequest
• SipServerInstantTestResponse
• SipServerProperties
• SipServerTest
• SipServerTests
• SipTestProtocol
• TestAuthType
• TestCustomHeaders
• TestDirection
• TestDnsServer
• TestDnsTransportProtocol
• TestDscpId
• TestHttpInterval
• TestInterval
• TestIpv6Policy
• TestLabel
• TestLinks
• TestMonitorsProperties
• TestPageLoadingStrategy
• TestPathTraceMode
• TestProbeMode
• TestProtocol
• TestRequest
• TestSelfLink
• TestSipCredentials
• TestSslVersionId
• TestSubInterval
• TestType
• Tests
• UnauthorizedError
• UnexpandedAgentToAgentTest
• UnexpandedAgentToServerTest
• UnexpandedApiTest
• UnexpandedBgpTest
• UnexpandedDnsSecTest
• UnexpandedDnsServerTest
• UnexpandedDnsTraceTest
• UnexpandedFtpServerTest
• UnexpandedHttpServerTest
• UnexpandedInstantTest
• UnexpandedPageLoadTest
• UnexpandedSipServerTest
• UnexpandedTest
• UnexpandedVoiceTest
• UnexpandedWebTransactionTest
• UpdateAgentToAgentTest
• UpdateAgentToServerTest
• UpdateApiTest
• UpdateBgpTest
• UpdateBgpTestRequest
• UpdateDnsSecTest
• UpdateDnsServerTest
• UpdateDnsTraceTest
• UpdateFtpServerTest
• UpdateHttpServerTest
• UpdatePageLoadTest
• UpdateSipServerTest
• UpdateSipServerTest1
• UpdateVoiceTest
• UpdateWebTransactionTest
• ValidationError
• ValidationErrorItem
• VoiceInstantTest
• VoiceProperties
• VoiceTest
• VoiceTests
• WebTransactionInstantTest
• WebTransactionProperties
• WebTransactionTest
• WebTransactionTests

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: Bearer authentication

Author