Synthetic locations API v2 - PUT public locations status

Changes the status of public synthetic locations.

The request consumes an application/json payload.

PUT	Managed	`https://{your-domain}/e/{your-environment-id}/api/v2/synthetic/locations/status`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/synthetic/locations/status`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/synthetic/locations/status`

Authentication

To execute this request, you need an access token with Write synthetic locations (syntheticLocations.write) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
body	SyntheticPublicLocationsStatus	The new status of public synthetic locations.	body	optional

Request body objects

The `SyntheticPublicLocationsStatus` object

The status of public synthetic locations.

Element	Type	Description
publicLocationsEnabled	boolean	Synthetic monitors can (`true`) or can't (`false`) run on public synthetic locations.

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

Code	Description
204	Success. Locations status has been updated.
409	Conflict. Public locations couldn't be disabled because there are monitors assigned to them.