• Home
  • API
  • Environment
  • Synthetic v2
  • Locations
  • PUT location status

Synthetic locations API v2 - PUT public locations status

Changes the status of public synthetic locations.

The request consumes an application/json payload.

PUTManagedDynatrace 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.write scope.

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

Parameters

ParameterTypeDescriptionInRequired
bodySyntheticPublicLocationsStatus

The new status of public synthetic locations.

bodyoptional

Request body objects

The SyntheticPublicLocationsStatus object

The status of public synthetic locations.

ElementTypeDescriptionRequired
publicLocationsEnabledboolean

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

required

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

json
{ "publicLocationsEnabled": true }

Response

Response codes

CodeDescription
204

Success. Locations status has been updated.

409

Conflict. Public locations couldn't be disabled because there are monitors assigned to them.

Related topics
  • Synthetic Monitoring

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