Synthetic configuration API v2 - GET configuration
Gets the configuration of Synthetic monitoring in your environment.
The request produces an application/json payload.
This request is an Early Adopter release and may be changed in non-compatible way.
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/config |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/synthetic/config | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/synthetic/config |
Authentication
To execute this request, you need Read synthetic locations (syntheticLocations.read) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.
Parameters
The request doesn't provide any configurable parameters.
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Synthetic | Success. The response contains synthetic related parameters defined for whole tenant. |
Response body objects
The SyntheticConfigDto object
A DTO for synthetic configuration.
| Element | Type | Description | Required |
|---|---|---|---|
| hmRequestTimeoutInMs | integer | - | optional |
| hmConnectTimeoutInMs | integer | - | optional |
| hmMaxHeaderSizeInBytes | integer | - | optional |
| hmExecutionTimeoutInMs | integer | - | optional |
| hmScriptExecutionTimeoutInMs | integer | - | optional |
| hmMaxRequestBodySizeInBytes | integer | - | optional |
| hmMaxCustomScriptSizeInBytes | integer | - | optional |
| hmMaxResponseBodySizeInBytes | integer | - | optional |
| hmMaxResponseBodySizeToCustomScriptInBytes | integer | - | optional |
| hmDnsQueryTimeoutInMs | integer | - | optional |
| bmMonitorTimeout | integer | bmMonitorTimeout - browser monitor execution timeout (ms) | required |
| bmStepTimeout | integer | bmStepTimeout - browser monitor single step execution timeout (ms) | required |
Response body JSON model
{
"hmRequestTimeoutInMs": 1,
"hmConnectTimeoutInMs": 1,
"hmMaxHeaderSizeInBytes": 1,
"hmExecutionTimeoutInMs": 1,
"hmScriptExecutionTimeoutInMs": 1,
"hmMaxRequestBodySizeInBytes": 1,
"hmMaxCustomScriptSizeInBytes": 1,
"hmMaxResponseBodySizeInBytes": 1,
"hmMaxResponseBodySizeToCustomScriptInBytes": 1,
"hmDnsQueryTimeoutInMs": 1,
"bmMonitorTimeout": 1,
"bmStepTimeout": 1
}Example
In this example, the request lists the current configuration of Synthetic monitoring.
The API token is passed in the Authorization header.
Curl
curl --request GET \
--url 'https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/config' \
--header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'Request URL
https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/configResponse body
{
"browserMonitorTimeout": 600000,
"browserMonitorStepTimeout": 60000
}Response code
200