Synthetic configuration API v2 - PUT configuration

Reference

Updates the configuration of Synthetic monitoring in your environment.

The request consumes an application/json payload.

PUT	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/synthetic/config`
PUT	Environment ActiveGateCluster ActiveGate	`https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/synthetic/config`

Authentication

To execute this request, you need an access token with syntheticLocations.write scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
body	SyntheticConfigDto	A DTO for synthetic configuration.	body	required

Request body objects

The `SyntheticConfigDto` object

A DTO for synthetic configuration.

Element	Type	Description	Required
bmMonitorTimeout	integer	bmMonitorTimeout - browser monitor execution timeout (ms)	required
bmStepTimeout	integer	bmStepTimeout - browser monitor single step execution timeout (ms)	required

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
  "bmMonitorTimeout": 1,
  "bmStepTimeout": 1
}

Response

Response codes

Code	Type	Description
204	SyntheticConfigDto	Success. The set of synthetic related parameters has been updated. Response doesn't have a body.
4XX	ErrorEnvelope	Client side error.
5XX	ErrorEnvelope	Server side error.

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 '{
  "bmMonitorTimeout": 300000,
  "bmStepTimeout": 30000
}'

Request URL

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

Request body

{
  "bmMonitorTimeout": 300000,
  "bmStepTimeout": 30000
}

Response code

204

Synthetic Monitoring