thousandeyes-sdk-python/thousandeyes-sdk-tests/docs/ApiTest.md

ApiTest

Properties

Name	Type	Description	Notes
interval	TestInterval
alerts_enabled	bool	Indicates if alerts are enabled.	[optional]
enabled	bool	Test is enabled.	[optional] [default to True]
alert_rules	**List[AlertRule]**	Contains list of enabled alert rule objects.	[optional]
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. Note: Saved Events are now called Private Snapshots in the user interface. This change does not affect API.	[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]**	Labels to which the test is assigned. This field is not returned for Instant Tests.	[optional] [readonly]
shared_with_accounts	**List[SharedWithAccount]**		[optional] [readonly]
collect_proxy_network_data	bool	Indicates whether network data to the proxy should be collected.	[optional] [default to False]
distributed_tracing	bool	Adds distributed tracing headers to API requests using B3 and W3C standards.	[optional]
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]
override_agent_proxy	bool	Flag indicating if a proxy other than the default should be used. To override the default proxy for agents, set to `true` and specify a value for `overrideProxyId`.	[optional] [default to False]
override_proxy_id	str	ID of the proxy to be used if the default proxy is overridden.	[optional]
path_trace_mode	TestPathTraceMode		[optional]
predefined_variables	**List[ApiPredefinedVariable]**		[optional]
probe_mode	TestProbeMode		[optional]
protocol	TestProtocol		[optional]
randomized_start_time	bool	Indicates whether agents should randomize the start time in each test round.	[optional] [default to False]
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.
credentials	List[str]	Contains a list of credential IDs (get `credentialId` from `/credentials` endpoint).	[optional]
bgp_measurements	bool	Set to `true` to enable bgp measurements.	[optional] [default to True]
use_public_bgp	bool	Indicate if all available public BGP monitors should be used, when ommited defaults to `bgpMeasurements` value.	[optional] [default to True]
monitors	**List[Monitor]**	Contains list of enabled BGP monitors.	[optional] [readonly]

Example

from thousandeyes_sdk.tests.models.api_test import ApiTest

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

# convert the object into a dict
api_test_dict = api_test_instance.to_dict()
# create an instance of ApiTest from a dict
api_test_from_dict = ApiTest.from_dict(api_test_dict)

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