Synthetic configuration API v2 - GET configuration

Gets the configuration of Synthetic monitoring in your environment.

The request produces an application/json payload.

GET	ManagedDynatrace for Government	`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 an access token with syntheticLocations.read scope.

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	SyntheticConfigDto	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
bmMonitorTimeout	integer	bmMonitorTimeout - browser monitor execution timeout (ms)
bmStepTimeout	integer	bmStepTimeout - browser monitor single step execution timeout (ms)

Response body JSON model

json
{
  "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

bash
curl --request GET \
  --url 'https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/config' \
  --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

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

Response body

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

Response code

200