• Home
  • Dynatrace API
  • Environment
  • Synthetic v2
  • Locations
  • GET location status

Synthetic locations API v2 - GET public locations status

Shows the status of public synthetic locations.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/synthetic/locations/status
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/synthetic/locations/status
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/synthetic/locations/status

Authentication

To execute this request, you need an access token with syntheticLocations.read scope.

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.

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

json
{ "publicLocationsEnabled": true }
Related topics
  • Synthetic Monitoring

    Learn about Synthetic Monitoring and how to create a single-URL browser monitor, a browser clickpath, or an HTTP monitor.