Synthetic locations API - PUT public locations status
Changes the status of public synthetic locations.
The request consumes an application/json
payload.
This request is an Early Adopter release and may be changed in non-compatible way.
PUT |
|
Authentication
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.
Parameters
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 ( |
required |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.
{
"publicLocationsEnabled": true
}
Response
Response codes
Code | Description |
---|---|
204 | Success. Locations status was updated successfully. |
409 | Conflict. Public locations could not be disabled since there are monitors assigned to them. |
Response body
A successful request doesn't return any content.