thousandeyes-sdk-python/thousandeyes-sdk-instant-tests/docs/HttpServerProperties.md
Jack Browne 92b9a0126c
CP-2126 Refactor HTTP client into shared package (#5)
* CP-2126 Refactor HTTP client into shared package

* CP-2126 Regenerate Python SDK
2024-05-23 11:57:23 +01:00

62 lines
4.6 KiB
Markdown

# HttpServerProperties
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**auth_type** | [**TestAuthType**](TestAuthType.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]
**headers** | **List[str]** | HTTP request headers used. | [optional]
**custom_headers** | [**TestCustomHeaders**](TestCustomHeaders.md) | | [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**](TestPathTraceMode.md) | | [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**](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]
**ipv6_policy** | [**TestIpv6Policy**](TestIpv6Policy.md) | | [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]
**type** | **str** | | [optional] [readonly]
## Example
```python
from thousandeyes_sdk.instant_tests.models.http_server_properties import HttpServerProperties
# TODO update the JSON string below
json = "{}"
# create an instance of HttpServerProperties from a JSON string
http_server_properties_instance = HttpServerProperties.from_json(json)
# print the JSON string representation of the object
print(HttpServerProperties.to_json())
# convert the object into a dict
http_server_properties_dict = http_server_properties_instance.to_dict()
# create an instance of HttpServerProperties from a dict
http_server_properties_from_dict = HttpServerProperties.from_dict(http_server_properties_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)