Synthetic locations API - GET public locations status

  • Reference
  • Published Jan 21, 2021

Shows the status of public synthetic locations.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v1/synthetic/locations/status
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/synthetic/locations/status

Authentication

To execute this request, you need an access token with one of the following scopes:

  • DataExport
  • ExternalSyntheticIntegration
  • ReadSyntheticData

To learn how to obtain and use it, see Tokens and authentication.

Parameters

The request doesn't provide any configurable parameters.

``

Response

Response codes

CodeTypeDescription
200SyntheticPublicLocationsStatus

Success. The response contains the public locations status.

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The SyntheticPublicLocationsStatus object

The status of public synthetic locations.

ElementTypeDescription
publicLocationsEnabledboolean

Synthetic monitors can (true) or can't (false) run on public synthetic locations.

Response body JSON model

{
  "publicLocationsEnabled": true
}