Synthetic locations API - PUT public locations status

Changes the status of public synthetic locations.

The request consumes an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

  • Managed https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/locations/status
  • SaaS https://{your-environment-id}
  • Environment ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/locations/status


To execute this request, you need the Create and read synthetic monitors, locations, and nodes (ExternalSyntheticIntegration) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.


Parameter Type Description In Required
body SyntheticPublicLocationsStatus

The updated synthetic locations status

body optional

Body format

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.



Response codes

Code Description

Success. Locations status was updated successfully.


Conflict. Public locations could not be disabled since there are monitors assigned to them.

Response body

A successful request doesn't return any content.