mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2025-12-06 06:26:51 +00:00
Some checks failed
Python CI / build (push) Has been cancelled
Co-authored-by: API Team <api-team@thousandeyes.com>
3.3 KiB
3.3 KiB
ApiProperties
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| client_certificate | str | String representation (containing newline characters) of client certificate, the private key must be placed first, then the certificate. | [optional] |
| client_cert_domains_allow_list | str | Comma separated list of domains to send the client certificate. | [optional] |
| 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] |
| type | str | [optional] [readonly] | |
| url | str | Target for the test. |
Example
from thousandeyes_sdk.instant_tests.models.api_properties import ApiProperties
# TODO update the JSON string below
json = "{}"
# create an instance of ApiProperties from a JSON string
api_properties_instance = ApiProperties.from_json(json)
# print the JSON string representation of the object
print(ApiProperties.to_json())
# convert the object into a dict
api_properties_dict = api_properties_instance.to_dict()
# create an instance of ApiProperties from a dict
api_properties_from_dict = ApiProperties.from_dict(api_properties_dict)