Retrieve public synthetic location status in Dynatrace with the Synthetic API and see whether public locations are enabled.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/synthetic/v1/locations/status |
You use the locations status endpoint to check the status of public synthetic locations. The response returns the current public locations status.
To execute this request, you need a platform token or OAuth access token with synthetic:locations: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. The response contains the public locations status. |
| 4XX | Error | Client side error. |
| 5XX | Error | Server side error. |
SyntheticPublicLocationsStatusDto objectThe status of public synthetic locations.
| Element | Type | Description |
|---|---|---|
| enabled | boolean | Synthetic monitors can ( |
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
|
{"enabled": true}
{"error": {"code": 1,"details": {"type": "constraintViolation"},"message": "string"}}