Try it free

Update synthetic configuration

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026
  • Early Access

Update tenant-wide synthetic settings in Dynatrace with the Synthetic API, including parameters that affect all monitors and private locations.

PUTSaaShttps://{your-environment-id}.apps.dynatrace.com/platform/synthetic/v1/configuration

Overview

You use the configuration endpoint to change the synthetic-related parameters defined for the whole tenant. The request body can include bmMonitorTimeout and bmStepTimeout, and the operation returns no body when the update succeeds.

Authentication

To execute this request, you need a platform token or OAuth access token with synthetic:environment-configuration:write scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
bodySyntheticConfigDto

The new set of synthetic-related parameters to apply to the whole tenant.

bodyRequired

Request body objects

The SyntheticConfigDto object

A DTO for synthetic configuration.

ElementTypeDescriptionRequired
bmMonitorTimeoutinteger

bmMonitorTimeout - browser monitor execution timeout (ms).

Required
bmStepTimeoutinteger

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

CodeTypeDescription
204-

Success. The set of synthetic-related parameters has been updated. The response doesn't have a body.

4XXErrorResponseEnvelope

Client side error.

5XXErrorResponseEnvelope

Server side error.

Response body objects

The ErrorResponseEnvelope object

Encloses the encountered error.

ElementTypeDescription
errorErrorResponse

Basic information of the encountered error.

The ErrorResponse object

Basic information of the encountered error.

ElementTypeDescription
codeinteger

The returned HTTP status code.

detailsErrorResponseDetails

Detailed information of the error.

messagestring

Description of the encountered error.

The ErrorResponseDetails object

Detailed information of the error.

ElementTypeDescription
typestring

Defines the actual set of fields depending on the value. See one of the following objects:

  • constraintViolation -> ConstraintViolationDetails
The element can hold these values
  • constraintViolation

Response body JSON models

{
"error": {
"code": 1,
"details": {
"type": "constraintViolation"
},
"message": "string"
}
}
Related tags
Platform APIDynatrace PlatformDigital Experience