thousandeyes-sdk-python/thousandeyes-sdk-tests/docs/ApiRequest.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

2.1 KiB

ApiRequest

Properties

Name Type Description Notes
assertions **List[ApiRequestAssertion]** List of assertion objects. [optional]
auth_type ApiRequestAuthType [optional]
bearer_token str The bearer token if `authType = bearer-token`. [optional]
body str POST/PUT request body. Must be in JSON format. [optional]
collect_api_response str Set to `true` if API response body should be collected and saved. Set to `false` if API response body should not be saved. [optional] [default to 'true']
headers **List[ApiRequestHeader]** Array of API Request Header objects. [optional]
method ApiRequestMethod [optional]
name str API step name, must be unique.
password str The password if `authType = basic`. [optional]
url str Request url. Supports variables in the format `{{variableName}}`.
username str The username if `authType = basic`. [optional]
variables **List[ApiRequestVariable]** Array of API post request variable objects. [optional]
wait_time_ms float Post request delay before executing the next API requests, in milliseconds. [optional]

Example

from thousandeyes_sdk.tests.models.api_request import ApiRequest

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

# convert the object into a dict
api_request_dict = api_request_instance.to_dict()
# create an instance of ApiRequest from a dict
api_request_from_dict = ApiRequest.from_dict(api_request_dict)

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