Update tenant-wide synthetic settings in Dynatrace with the Synthetic API, including parameters that affect all monitors and private locations.
| PUT | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/synthetic/v1/configuration |
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.
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.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| body | Synthetic | The new set of synthetic-related parameters to apply to the whole tenant. | body | Required |
SyntheticConfigDto objectA 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 |
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}
| Code | Type | Description |
|---|---|---|
| 204 | - | Success. The set of synthetic-related parameters has been updated. The response doesn't have a body. |
| 4XX | Error | Client side error. |
| 5XX | Error | Server side error. |
ErrorResponseEnvelope objectEncloses the encountered error.
| Element | Type | Description |
|---|---|---|
| error | Error | Basic information of the encountered error. |
ErrorResponse objectBasic information of the encountered error.
| Element | Type | Description |
|---|---|---|
| code | integer | The returned HTTP status code. |
| details | Error | Detailed information of the error. |
| message | string | Description of the encountered error. |
ErrorResponseDetails objectDetailed information of the error.
| Element | Type | Description |
|---|---|---|
| type | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
{"error": {"code": 1,"details": {"type": "constraintViolation"},"message": "string"}}