Synthetic configuration API v2 - PUT configuration

Updates the configuration of Synthetic monitoring in your environment.

The request consumes an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

PUT
  • 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 Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter Type Description In Required
body SyntheticConfigDto body optional

Body format

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
browserMonitorTimeout integer

browserMonitorTimeout - browser monitor execution timeout (ms)

required
browserMonitorStepTimeout integer

browserMonitorStepTimeout - browser monitor single step execution timeout (ms)

required

Response

Response codes

Code Description
204

Success. Response doesn't have a body.

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 updates the configuration of the Synthetic monitoring from the GET request example. It halves the timeouts for browser monitor and browser monitor steps—setting them to 300,000 and 30,000 respectively.

The API token is passed in the Authorization header.

You can download or copy the example request body to try it out on your own. Be sure to create a backup copy of your current configuration with the GET Synthetic configuration call.

Curl

curl --request PUT \
  --url https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/config \
  --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
  --header 'Content-Type: application/json' \
  --data '{
  "browserMonitorTimeout": 300000,
  "browserMonitorStepTimeout": 30000
}'

Request URL

https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/config

Request body

{
  "browserMonitorTimeout": 300000,
  "browserMonitorStepTimeout": 30000
}

Response code

204