Synthetic locations API v2 - PUT public locations status

Changes the status of public synthetic locations.

The request consumes an application/json payload.

PUTSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/synthetic/locations/status
Environment ActiveGateCluster ActiveGatehttps://{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.

Parameters

Parameter
Type
Description
In
Required
body

The new status of public synthetic locations.

body
required

Request body objects

The SyntheticPublicLocationsStatus object

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

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.

{
  "publicLocationsEnabled": true
}

Response

Response codes

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

Client side error.

5XX

Server side error.

Related topics