thousandeyes-sdk-python/instant_tests_api/docs/HttpServerInstantTestRequest.md

HttpServerInstantTestRequest

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	UnexpandedInstantTestLinks		[optional]
labels	List[str]	A list of test label identifiers (get `labelId` from `/labels` endpoint).	[optional]
shared_with_accounts	List[str]	A list of account group identifiers that the test is shared with (get `aid` from `/account-groups` endpoint).	[optional]
agents	**List[InstantTestRequestAgentsInner]**	A list of objects with `agentId` (required) and `sourceIpAddress` (optional).
auth_type	TestAuthType		[optional]
bandwidth_measurements	bool	Set to `true` to enable bandwidth measurements, only applies to Enterprise agents assigned to the test.	[optional]
client_certificate	str	String representation (containing newline characters) of client certificate, the private key must be placed first, then the certificate.	[optional]
content_regex	str	Content regex, this field does not require escaping.	[optional]
headers	List[str]	HTTP request headers used.	[optional]
custom_headers	TestCustomHeaders		[optional]
desired_status_code	str	Specify the HTTP status code value that indicates a successful response.	[optional] [default to '200']
download_limit	int	Specifies maximum number of bytes to download from the target object.	[optional]
dns_override	str	IP address to use for DNS override.	[optional]
http_target_time	int	Target time for HTTP server completion, specified in milliseconds.	[optional]
http_time_limit	int	HTTP time limit in seconds.	[optional] [default to 5]
http_version	int	HTTP protocol version. Set to '2' to prefer HTTP/2, or '1' to use only HTTP/1.1.	[optional] [default to 2]
include_headers	bool	Set to `true` to capture response headers for objects loaded by the test.	[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]
password	str	Password for Basic/NTLM authentication.	[optional]
path_trace_mode	TestPathTraceMode		[optional]
post_body	str	Enter the body for the HTTP POST request in this field. No special escaping is necessary. If the post body is provided with content, the `requestMethod` is automatically set to POST.	[optional]
probe_mode	TestProbeMode		[optional]
protocol	TestProtocol		[optional]
ssl_version	str	Reflects the verbose SSL protocol version used by a test.	[optional] [readonly]
ssl_version_id	TestSslVersionId		[optional]
url	str	Target for the test.
use_ntlm	bool	Set to true to use NTLM, false to use Basic Authentication. Requires username and password to be set.	[optional]
user_agent	str	User-agent string to be provided during the test.	[optional]
username	str	Username for Basic/NTLM authentication.	[optional]
verify_certificate	bool	Ignore or acknowledge certificate errors. Set to false to ignore certificate errors.	[optional] [default to False]
ipv6_policy	TestIpv6Policy		[optional]
follow_redirects	bool	To disable following HTTP/301 or HTTP/302 redirect directives, set this parameter to `false`.	[optional] [default to True]
fixed_packet_rate	int	Sets packets rate sent to measure the network in packets per second.	[optional]

Example

from instant_tests_api.models.http_server_instant_test_request import HttpServerInstantTestRequest

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

# convert the object into a dict
http_server_instant_test_request_dict = http_server_instant_test_request_instance.to_dict()
# create an instance of HttpServerInstantTestRequest from a dict
http_server_instant_test_request_form_dict = http_server_instant_test_request.from_dict(http_server_instant_test_request_dict)

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