Synthetic configuration API v2 - GET configuration

Gets the configuration of Synthetic monitoring in your environment.

The request produces an application/json payload.

Early Adopter

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 the Read configuration (ReadConfig) 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 Description
200

Success

Response body

The SyntheticConfigDto object

A DTO for synthetic configuration.

Element Type Description
hmRequestTimeoutInMs integer
hmConnectTimeoutInMs integer
hmMaxHeaderSizeInBytes integer
hmExecutionTimeoutInMs integer
hmScriptExecutionTimeoutInMs integer
hmMaxRequestBodySizeInBytes integer
hmMaxCustomScriptSizeInBytes integer
hmMaxResponseBodySizeInBytes integer
hmMaxResponseBodySizeToCustomScriptInBytes integer
hmDnsQueryTimeoutInMs integer
browserMonitorTimeout integer

browserMonitorTimeout - browser monitor execution timeout (ms)

browserMonitorStepTimeout integer

browserMonitorStepTimeout - browser monitor single step execution timeout (ms)

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/config

Response body

{
  "browserMonitorTimeout": 600000,
  "browserMonitorStepTimeout": 60000
}

Response code

200