Retrieve tenant-wide synthetic settings in Dynatrace with the Synthetic API, including parameters that affect all monitors and private locations.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/synthetic/v1/configuration |
You use the configuration endpoint to read the synthetic-related parameters defined for the whole tenant. The response returns the current settings that affect all monitors and all private locations.
To execute this request, you need a platform token or OAuth access token with synthetic:environment-configuration:read scope. To learn how to obtain and use it, see Tokens and authentication.
The request doesn't provide any configurable parameters.
| Code | Type | Description |
|---|---|---|
| 200 | Synthetic | Success |
| 4XX | Error | Client side error. |
| 5XX | Error | Server side error. |
SyntheticConfigDto objectA 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). |
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
|
{"bmMonitorTimeout": 1,"bmStepTimeout": 1}
{"error": {"code": 1,"details": {"type": "constraintViolation"},"message": "string"}}