mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2025-12-06 16:05:30 +00:00
224 lines
10 KiB
Markdown
224 lines
10 KiB
Markdown
# thousandeyes-sdk-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](https://openapi-generator.tech) project:
|
|
|
|
- API version: 7.0.4
|
|
- Package version: 1.0.0
|
|
- Generator version: 7.6.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:
|
|
|
|
```sh
|
|
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:
|
|
```python
|
|
import thousandeyes_sdk.instant_tests
|
|
```
|
|
|
|
### Setuptools
|
|
|
|
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
|
|
|
|
```sh
|
|
python setup.py install --user
|
|
```
|
|
(or `sudo python setup.py install` to install the package for all users)
|
|
|
|
Then import the package:
|
|
```python
|
|
import thousandeyes_sdk.instant_tests
|
|
```
|
|
|
|
### Tests
|
|
|
|
Execute `pytest` to run the tests.
|
|
|
|
## Getting Started
|
|
|
|
Please follow the [installation procedure](#installation--usage) and then run the following:
|
|
|
|
```python
|
|
|
|
import thousandeyes_sdk.client
|
|
import thousandeyes_sdk.instant_tests
|
|
from thousandeyes_sdk.client.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.client.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.client.Configuration(
|
|
access_token = os.environ["BEARER_TOKEN"]
|
|
)
|
|
|
|
|
|
# Enter a context with an instance of the API client
|
|
with thousandeyes_sdk.client.ApiClient(configuration) as api_client:
|
|
# Create an instance of the API class
|
|
api_instance = thousandeyes_sdk.instant_tests.APIApi(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.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 API instant test
|
|
api_response = api_instance.post_instant_api(api_instant_test_request, aid=aid, expand=expand)
|
|
print("The response of APIApi->post_instant_api:\n")
|
|
pprint(api_response)
|
|
except ApiException as e:
|
|
print("Exception when calling APIApi->post_instant_api: %s\n" % e)
|
|
|
|
```
|
|
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to *https://api.thousandeyes.com*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*APIApi* | [**post_instant_api**](docs/APIApi.md#post_instant_api) | **POST** /v7/tests/api/instant | Create API instant test
|
|
*AgentToAgentApi* | [**post_instant_test_agent_to_agent**](docs/AgentToAgentApi.md#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**](docs/AgentToServerApi.md#post_instant_agent_to_server) | **POST** /v7/tests/agent-to-server/instant | Create agent-to-server instant test
|
|
*DNSSecurityApi* | [**post_instant_dns_sec**](docs/DNSSecurityApi.md#post_instant_dns_sec) | **POST** /v7/tests/dnssec/instant | Create DNS security instant test
|
|
*DNSServerApi* | [**post_instant_dns_server**](docs/DNSServerApi.md#post_instant_dns_server) | **POST** /v7/tests/dns-server/instant | Create DNS server instant test
|
|
*DNSTraceApi* | [**post_instant_dns_trace**](docs/DNSTraceApi.md#post_instant_dns_trace) | **POST** /v7/tests/dns-trace/instant | Create DNS trace instant test
|
|
*FTPServerApi* | [**post_instant_ftp_server**](docs/FTPServerApi.md#post_instant_ftp_server) | **POST** /v7/tests/ftp-server/instant | Create FTP server instant test
|
|
*HTTPPageLoadApi* | [**post_instant_http_page_load**](docs/HTTPPageLoadApi.md#post_instant_http_page_load) | **POST** /v7/tests/page-load/instant | Create HTTP page load instant test
|
|
*HTTPServerApi* | [**post_instant_http_server**](docs/HTTPServerApi.md#post_instant_http_server) | **POST** /v7/tests/http-server/instant | Create HTTP server instant test
|
|
*RunApi* | [**post_instant_run**](docs/RunApi.md#post_instant_run) | **POST** /v7/tests/{testId}/run | Run instant test
|
|
*SIPServerApi* | [**post_instant_sip_server**](docs/SIPServerApi.md#post_instant_sip_server) | **POST** /v7/tests/sip-server/instant | Create SIP server instant test
|
|
*VoiceApi* | [**post_instant_voice**](docs/VoiceApi.md#post_instant_voice) | **POST** /v7/tests/voice/instant | Create voice instant test
|
|
*WebTransactionApi* | [**post_instant_web_transactions**](docs/WebTransactionApi.md#post_instant_web_transactions) | **POST** /v7/tests/web-transactions/instant | Create web transactions instant test
|
|
|
|
|
|
## Documentation For Models
|
|
|
|
- [Agent](docs/Agent.md)
|
|
- [AgentBase](docs/AgentBase.md)
|
|
- [AgentToAgentInstantTest](docs/AgentToAgentInstantTest.md)
|
|
- [AgentToAgentInstantTestRequest](docs/AgentToAgentInstantTestRequest.md)
|
|
- [AgentToAgentProperties](docs/AgentToAgentProperties.md)
|
|
- [AgentToAgentTestProtocol](docs/AgentToAgentTestProtocol.md)
|
|
- [AgentToServerInstantTest](docs/AgentToServerInstantTest.md)
|
|
- [AgentToServerInstantTestRequest](docs/AgentToServerInstantTestRequest.md)
|
|
- [AgentToServerProperties](docs/AgentToServerProperties.md)
|
|
- [ApiInstantTest](docs/ApiInstantTest.md)
|
|
- [ApiInstantTestRequest](docs/ApiInstantTestRequest.md)
|
|
- [ApiPredefinedVariable](docs/ApiPredefinedVariable.md)
|
|
- [ApiProperties](docs/ApiProperties.md)
|
|
- [ApiRequest](docs/ApiRequest.md)
|
|
- [ApiRequestAssertion](docs/ApiRequestAssertion.md)
|
|
- [ApiRequestAssertionName](docs/ApiRequestAssertionName.md)
|
|
- [ApiRequestAssertionOperator](docs/ApiRequestAssertionOperator.md)
|
|
- [ApiRequestAuthType](docs/ApiRequestAuthType.md)
|
|
- [ApiRequestHeader](docs/ApiRequestHeader.md)
|
|
- [ApiRequestMethod](docs/ApiRequestMethod.md)
|
|
- [ApiRequestVariable](docs/ApiRequestVariable.md)
|
|
- [CloudEnterpriseAgentType](docs/CloudEnterpriseAgentType.md)
|
|
- [DnsQueryClass](docs/DnsQueryClass.md)
|
|
- [DnsSecInstantTest](docs/DnsSecInstantTest.md)
|
|
- [DnsSecInstantTestRequest](docs/DnsSecInstantTestRequest.md)
|
|
- [DnsSecProperties](docs/DnsSecProperties.md)
|
|
- [DnsServerInstantTest](docs/DnsServerInstantTest.md)
|
|
- [DnsServerInstantTestRequest](docs/DnsServerInstantTestRequest.md)
|
|
- [DnsServerProperties](docs/DnsServerProperties.md)
|
|
- [DnsServersRequest](docs/DnsServersRequest.md)
|
|
- [DnsTraceInstantTest](docs/DnsTraceInstantTest.md)
|
|
- [DnsTraceInstantTestRequest](docs/DnsTraceInstantTestRequest.md)
|
|
- [DnsTraceProperties](docs/DnsTraceProperties.md)
|
|
- [Error](docs/Error.md)
|
|
- [Expand](docs/Expand.md)
|
|
- [FtpServerInstantTest](docs/FtpServerInstantTest.md)
|
|
- [FtpServerProperties](docs/FtpServerProperties.md)
|
|
- [FtpServerRequestType](docs/FtpServerRequestType.md)
|
|
- [HttpServerInstantTest](docs/HttpServerInstantTest.md)
|
|
- [HttpServerInstantTestRequest](docs/HttpServerInstantTestRequest.md)
|
|
- [HttpServerProperties](docs/HttpServerProperties.md)
|
|
- [InstantTest](docs/InstantTest.md)
|
|
- [InstantTestRequest](docs/InstantTestRequest.md)
|
|
- [Link](docs/Link.md)
|
|
- [PageLoadInstantTest](docs/PageLoadInstantTest.md)
|
|
- [PageLoadInstantTestRequest](docs/PageLoadInstantTestRequest.md)
|
|
- [PageLoadProperties](docs/PageLoadProperties.md)
|
|
- [ServerInstantTestRequest](docs/ServerInstantTestRequest.md)
|
|
- [SharedWithAccount](docs/SharedWithAccount.md)
|
|
- [SimpleAgent](docs/SimpleAgent.md)
|
|
- [SipServerInstantTest](docs/SipServerInstantTest.md)
|
|
- [SipServerInstantTestRequest](docs/SipServerInstantTestRequest.md)
|
|
- [SipServerInstantTestRequest1](docs/SipServerInstantTestRequest1.md)
|
|
- [SipServerInstantTestResponse](docs/SipServerInstantTestResponse.md)
|
|
- [SipServerProperties](docs/SipServerProperties.md)
|
|
- [SipTestProtocol](docs/SipTestProtocol.md)
|
|
- [TestAgent](docs/TestAgent.md)
|
|
- [TestAuthType](docs/TestAuthType.md)
|
|
- [TestCustomHeaders](docs/TestCustomHeaders.md)
|
|
- [TestDirection](docs/TestDirection.md)
|
|
- [TestDnsServer](docs/TestDnsServer.md)
|
|
- [TestDnsTransportProtocol](docs/TestDnsTransportProtocol.md)
|
|
- [TestDscpId](docs/TestDscpId.md)
|
|
- [TestIpv6Policy](docs/TestIpv6Policy.md)
|
|
- [TestLabel](docs/TestLabel.md)
|
|
- [TestLinks](docs/TestLinks.md)
|
|
- [TestPageLoadingStrategy](docs/TestPageLoadingStrategy.md)
|
|
- [TestPathTraceMode](docs/TestPathTraceMode.md)
|
|
- [TestProbeMode](docs/TestProbeMode.md)
|
|
- [TestProtocol](docs/TestProtocol.md)
|
|
- [TestSelfLink](docs/TestSelfLink.md)
|
|
- [TestSipCredentials](docs/TestSipCredentials.md)
|
|
- [TestSslVersionId](docs/TestSslVersionId.md)
|
|
- [TestType](docs/TestType.md)
|
|
- [UnauthorizedError](docs/UnauthorizedError.md)
|
|
- [UnexpandedInstantTest](docs/UnexpandedInstantTest.md)
|
|
- [ValidationError](docs/ValidationError.md)
|
|
- [ValidationErrorItem](docs/ValidationErrorItem.md)
|
|
- [VoiceInstantTest](docs/VoiceInstantTest.md)
|
|
- [VoiceInstantTestRequest](docs/VoiceInstantTestRequest.md)
|
|
- [VoiceProperties](docs/VoiceProperties.md)
|
|
- [WebTransactionInstantTest](docs/WebTransactionInstantTest.md)
|
|
- [WebTransactionInstantTestRequest](docs/WebTransactionInstantTestRequest.md)
|
|
- [WebTransactionProperties](docs/WebTransactionProperties.md)
|
|
|
|
|
|
<a id="documentation-for-authorization"></a>
|
|
## Documentation For Authorization
|
|
|
|
|
|
Authentication schemes defined for the API:
|
|
<a id="BearerAuth"></a>
|
|
### BearerAuth
|
|
|
|
- **Type**: Bearer authentication
|
|
|
|
|
|
## Author
|
|
|
|
|
|
|
|
|