thousandeyes-sdk-python/thousandeyes-sdk-instant-tests/docs/ApiInstantTest.md
Shahid Hussain Khan 745e74afc4
CP-2189 Update SDK names for admin and monitors modules (#9)
* CP-2189 Update SDK names for admin and monitors modules

* CP-2189 Move client to core

* CP-2189 Change client to core
2024-06-04 16:09:40 +01:00

3.6 KiB

ApiInstantTest

Properties

Name Type Description Notes
created_by str User that created the test. [optional] [readonly]
created_date datetime UTC created date (ISO date-time format). [optional] [readonly]
description str A description of the test. [optional]
live_share bool Indicates if the test is shared with the account group. [optional] [readonly]
modified_by str User that modified the test. [optional] [readonly]
modified_date datetime UTC last modification date (ISO date-time format). [optional] [readonly]
saved_event bool Indicates if the test is a saved event. [optional] [readonly]
test_id str Each test is assigned an unique ID; this is used to access test information and results from other endpoints. [optional] [readonly]
test_name str The name of the test. Test name must be unique. [optional]
type str [optional] [readonly]
links TestLinks [optional]
labels **List[TestLabel]** [optional] [readonly]
shared_with_accounts **List[SharedWithAccount]** [optional] [readonly]
follow_redirects bool To disable following HTTP/301 or HTTP/302 redirect directives, set this parameter to `false`. [optional] [default to True]
mtu_measurements bool Set `true` to measure MTU sizes on network from agents to the target. [optional]
network_measurements bool Enable or disable network measurements. Set to true to enable or false to disable network measurements. [optional] [default to True]
num_path_traces int Number of path traces executed by the agent. [optional] [default to 3]
path_trace_mode TestPathTraceMode [optional]
predefined_variables **List[ApiPredefinedVariable]** [optional]
probe_mode TestProbeMode [optional]
protocol TestProtocol [optional]
requests **List[ApiRequest]**
ssl_version_id TestSslVersionId [optional]
target_time int Target time for completion metric, defaults to 50% of time limit specified in seconds. (0 means default behavior) [optional]
time_limit int Time limit for transaction in seconds. Exceeding this limit will result in a Timeout error. [optional] [default to 30]
url str Target for the test.
agents **List[Agent]** Contains list of agents. [optional] [readonly]
credentials List[str] Contains a list of credential IDs (get `credentialId` from `/credentials` endpoint). [optional]

Example

from thousandeyes_sdk.instant_tests.models.api_instant_test import ApiInstantTest

# TODO update the JSON string below
json = "{}"
# create an instance of ApiInstantTest from a JSON string
api_instant_test_instance = ApiInstantTest.from_json(json)
# print the JSON string representation of the object
print(ApiInstantTest.to_json())

# convert the object into a dict
api_instant_test_dict = api_instant_test_instance.to_dict()
# create an instance of ApiInstantTest from a dict
api_instant_test_from_dict = ApiInstantTest.from_dict(api_instant_test_dict)

[Back to Model list] [Back to API list] [Back to README]