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

102 lines
4.6 KiB
Markdown

# thousandeyes_sdk.instant_tests.DNSSecurityApi
All URIs are relative to *https://api.thousandeyes.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**post_instant_dns_sec**](DNSSecurityApi.md#post_instant_dns_sec) | **POST** /v7/tests/dnssec/instant | Create DNS security instant test
# **post_instant_dns_sec**
> DnsSecInstantTest post_instant_dns_sec(dns_sec_instant_test_request, aid=aid, expand=expand)
Create DNS security instant test
Creates and runs a new DNS security instant test.
### Example
* Bearer Authentication (BearerAuth):
```python
import thousandeyes_sdk.instant_tests
from thousandeyes_sdk.instant_tests.models.dns_sec_instant_test import DnsSecInstantTest
from thousandeyes_sdk.instant_tests.models.dns_sec_instant_test_request import DnsSecInstantTestRequest
from thousandeyes_sdk.instant_tests.models.expand import Expand
from thousandeyes_sdk.instant_tests.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.thousandeyes.com
# See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.client.Configuration(
host = "https://api.thousandeyes.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization: BearerAuth
configuration = thousandeyes_sdk.client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with thousandeyes_sdk.instant_tests.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = thousandeyes_sdk.instant_tests.DNSSecurityApi(api_client)
dns_sec_instant_test_request = thousandeyes_sdk.instant_tests.DnsSecInstantTestRequest() # DnsSecInstantTestRequest |
aid = '1234' # str | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. (optional)
expand = [thousandeyes_sdk.instant_tests.Expand()] # List[Expand] | (Optional) Indicates if the test sub-resources should be expanded. Defaults to no expansion. To expand the `agents` sub-resource, use the query `?expand=agent`. (optional)
try:
# Create DNS security instant test
api_response = api_instance.post_instant_dns_sec(dns_sec_instant_test_request, aid=aid, expand=expand)
print("The response of DNSSecurityApi->post_instant_dns_sec:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DNSSecurityApi->post_instant_dns_sec: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**dns_sec_instant_test_request** | [**DnsSecInstantTestRequest**](DnsSecInstantTestRequest.md)| |
**aid** | **str**| A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. | [optional]
**expand** | [**List[Expand]**](Expand.md)| (Optional) Indicates if the test sub-resources should be expanded. Defaults to no expansion. To expand the `agents` sub-resource, use the query `?expand=agent`. | [optional]
### Return type
[**DnsSecInstantTest**](DnsSecInstantTest.md)
### Authorization
[BearerAuth](../README.md#BearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/hal+json, application/problem+json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**201** | Created | * Location - <br> |
**400** | Bad Request | - |
**401** | Unauthorized | - |
**403** | Insufficient permissions to query endpoint | - |
**404** | Not found | - |
**429** | Exhausted rate limit for the organization | - |
**500** | Internal server error | - |
**502** | Bad Gateway | - |
**0** | An error occurred | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)