Synthetic locations API v2 - PUT public locations status

Changes the status of public synthetic locations.

The request consumes an application/json payload.

PUT	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/synthetic/locations/status`
PUT	Environment ActiveGateCluster ActiveGate	`https://{your-activegate-domain}:9999/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.

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

The status of public synthetic locations.

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

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

{
  "publicLocationsEnabled": true
}

Code	Type	Description
204	-	Success. Locations status has been updated.
409	-	Conflict. Public locations couldn't be disabled because there are monitors assigned to them.
4XX	ErrorEnvelope	Client side error.
5XX	ErrorEnvelope	Server side error.