Synthetic configuration API v2 - GET configuration

  • Reference
  • Published Oct 07, 2021

Gets the configuration of Synthetic monitoring in your environment.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/synthetic/config
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/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

CodeTypeDescription
200SyntheticConfigDto

Success. The response contains synthetic related parameters defined for whole tenant.

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The SyntheticConfigDto object

A DTO for synthetic configuration.

ElementTypeDescription
bmMonitorTimeoutinteger

bmMonitorTimeout - browser monitor execution timeout (ms)

bmStepTimeoutinteger

bmStepTimeout - browser monitor single step execution timeout (ms)

Response body JSON model

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

Response body

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

Response code

200