mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2025-12-06 14:36:50 +00:00
Some checks failed
Python CI / build (push) Has been cancelled
Co-authored-by: API Team <api-team@thousandeyes.com>
88 lines
7.8 KiB
Markdown
88 lines
7.8 KiB
Markdown
# HttpServerTestRequest
|
|
|
|
|
|
## Properties
|
|
|
|
Name | Type | Description | Notes
|
|
------------ | ------------- | ------------- | -------------
|
|
**interval** | [**TestInterval**](TestInterval.md) | |
|
|
**alerts_enabled** | **bool** | Indicates if alerts are enabled. | [optional]
|
|
**enabled** | **bool** | Test is enabled. | [optional] [default to True]
|
|
**alert_rules** | **List[str]** | List of alert rules IDs to apply to the test (get `ruleId` from `/alerts/rules` endpoint. If `alertsEnabled` is set to `true` and `alertRules` is not included on test creation or update, applicable user default alert rules will be used) | [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. | [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**](TestLinks.md) | | [optional]
|
|
**labels** | **List[str]** | Contains list of test label IDs (get `labelId` from `/labels` endpoint) | [optional]
|
|
**shared_with_accounts** | **List[str]** | Contains list of account group IDs. Test is shared with the listed account groups (get `aid` from `/account-groups` endpoint) | [optional]
|
|
**auth_type** | [**TestAuthType**](TestAuthType.md) | | [optional]
|
|
**agent_interfaces** | [**AgentInterfaces**](AgentInterfaces.md) | | [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]
|
|
**custom_headers** | [**TestCustomHeaders**](TestCustomHeaders.md) | | [optional]
|
|
**desired_status_code** | **str** | Specify the HTTP status code value that indicates a successful response. The default value accepts any 2xx or 3xx status code. | [optional] [default to 'default']
|
|
**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]
|
|
**o_auth** | [**OAuth**](OAuth.md) | | [optional]
|
|
**password** | **str** | Password for Basic/NTLM authentication. | [optional]
|
|
**path_trace_mode** | [**TestPathTraceMode**](TestPathTraceMode.md) | | [optional]
|
|
**probe_mode** | [**TestProbeMode**](TestProbeMode.md) | | [optional]
|
|
**protocol** | [**TestProtocol**](TestProtocol.md) | | [optional]
|
|
**ssl_version** | **str** | Reflects the verbose SSL protocol version used by a test. | [optional] [readonly]
|
|
**ssl_version_id** | [**TestSslVersionId**](TestSslVersionId.md) | | [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]
|
|
**allow_unsafe_legacy_renegotiation** | **bool** | Allows TLS renegotiation with servers not supporting RFC 5746. Default Set to true to allow unsafe legacy renegotiation. | [optional] [default to True]
|
|
**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]
|
|
**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]
|
|
**collect_proxy_network_data** | **bool** | Indicates whether network data to the proxy should be collected. | [optional] [default to False]
|
|
**headers** | **List[str]** | HTTP request headers used. | [optional]
|
|
**randomized_start_time** | **bool** | Indicates whether agents should randomize the start time in each test round. | [optional] [default to False]
|
|
**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]
|
|
**ipv6_policy** | [**TestIpv6Policy**](TestIpv6Policy.md) | | [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[str]** | Contains list of BGP monitor IDs (get `monitorId` from `/monitors` endpoint) | [optional]
|
|
**agents** | [**List[TestAgentRequest]**](TestAgentRequest.md) | Contains list of Agent IDs (get `agentId` from `/agents` endpoint). |
|
|
|
|
## Example
|
|
|
|
```python
|
|
from thousandeyes_sdk.tests.models.http_server_test_request import HttpServerTestRequest
|
|
|
|
# TODO update the JSON string below
|
|
json = "{}"
|
|
# create an instance of HttpServerTestRequest from a JSON string
|
|
http_server_test_request_instance = HttpServerTestRequest.from_json(json)
|
|
# print the JSON string representation of the object
|
|
print(HttpServerTestRequest.to_json())
|
|
|
|
# convert the object into a dict
|
|
http_server_test_request_dict = http_server_test_request_instance.to_dict()
|
|
# create an instance of HttpServerTestRequest from a dict
|
|
http_server_test_request_from_dict = HttpServerTestRequest.from_dict(http_server_test_request_dict)
|
|
```
|
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
|
|
|