Update public synthetic location status in Dynatrace with the Synthetic API by setting whether public locations are enabled.
| PUT | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/synthetic/v1/locations/status |
You use the locations status endpoint to change the status of public synthetic locations. The request body includes enabled, 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:locations:write scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| body | Synthetic | The new status of public synthetic locations. | body | Required |
SyntheticPublicLocationsStatusDto objectThe status of public synthetic locations.
| Element | Type | Description | Required |
|---|---|---|---|
| enabled | boolean | Synthetic monitors can ( | Required |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"enabled": true}
| Code | Type | Description |
|---|---|---|
| 204 | - | Success. Locations status has been updated. |
| 409 | - | Conflict. Public locations couldn't be disabled because there are monitors assigned to them. |
| 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"}}