thousandeyes-sdk-python/thousandeyes-sdk-endpoint-instant-tests/docs/EndpointHttpServerInstantTest.md
2024-09-25 07:39:02 +00:00

4.2 KiB

EndpointHttpServerInstantTest

Properties

Name Type Description Notes
agent_selector_type EndpointTestAgentSelectorType [optional]
agents List[str] List of endpoint agent IDs (obtained from `/endpoint/agents` endpoint). Required when `agentSelectorType` is set to `specific-agent`. [optional]
endpoint_agent_labels List[str] List of endpoint agent label IDs (obtained from `/endpoint/labels` endpoint), required when `agentSelectorType` is set to `agent-labels`. [optional]
max_machines int Maximum number of agents which can execute the test. [optional] [default to 25]
test_name str Name of the test.
auth_type EndpointTestAuthType [optional]
has_path_trace_in_session bool Enables "in session" path trace. When enabled, this option initiates a TCP session with the target server and sends path trace packets within the established TCP session. [optional]
http_time_limit int Maximum amount of time in milliseconds the agents wait before a request times out. [optional] [default to 5000]
protocol EndpointTestProtocol [optional]
username str Username for Basic/NTLM authentication. [optional]
ssl_version_id TestSslVersionId [optional]
tcp_probe_mode TestProbeModeResponse [optional]
verify_certificate bool Flag indicating if a certificate should be verified. [optional] [default to True]
url str The test target URL. You can optionally specify the protocol (`http` or `https`). - Default Protocol: If no protocol is specified, `https` is used by default. - Port Number: To specify a port, append it to the URL with a colon after the hostname or IP address (e.g., `https://example.com:443`). - If no port is specified in the URL, the `port` is determined by either the deprecated `port` field or the default protocol (HTTP: 80, HTTPS: 443).
has_ping bool Optional flag indicating if the test should run ping. [optional] [default to True]
has_traceroute bool Optional flag indicating if the test should run traceroute. [optional] [default to True]
network_measurements bool Enable or disable network measurements. Set to true to enable or false to disable network measurements. [optional] [default to True]
target_response_time int Response time target in milliseconds. Affects the colors of agents and legends on the view page. The value is compared with actual response time in order to determine the color scale (from green to red). [optional] [default to 1000]
password str Password for Basic/NTLM authentication. [optional]
port int (Deprecated) The port number to use for the test. It's recommended to specify the port directly in the `url` field instead. If this field is set, it will override the default protocol ports (HTTP: 80, HTTPS: 443) and any port specified in the `url`. [optional]

Example

from thousandeyes_sdk.endpoint_instant_tests.models.endpoint_http_server_instant_test import EndpointHttpServerInstantTest

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

# convert the object into a dict
endpoint_http_server_instant_test_dict = endpoint_http_server_instant_test_instance.to_dict()
# create an instance of EndpointHttpServerInstantTest from a dict
endpoint_http_server_instant_test_from_dict = EndpointHttpServerInstantTest.from_dict(endpoint_http_server_instant_test_dict)

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