Synthetic locations API v2 - PUT a location

  • Private locations Updates an existing location.
  • Public locations Changes the status of an existing location.

The request consumes an application/json payload.

Endpoint

/api/cluster/v2/synthetic/locations

Parameters

To find all model variations that depend on the type of the model, see JSON models.

Parameter Type Description In Required
locationId string

The Dynatrace entity ID of the synthetic location to be updated.

path required
body SyntheticLocationUpdate

The JSON body of the request. Contains updated parameters of the location.

body optional

Body format

The SyntheticLocationUpdate object

The synthetic location update. This is a base object, the exact type depends on the value of the type field.

Element Type Description Required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • PUBLIC -> SyntheticPublicLocationUpdate
  • PRIVATE -> SyntheticPrivateLocationUpdate
The type element can hold these values.
optional

Possible values

Possible values for the type element in the SyntheticLocationUpdate object:

  • PRIVATE
  • PUBLIC

Response

Response codes

Code Description
204

Success. The location has been updated. Response doesn't have a body.

Response body

A successful request doesn't return any content.

Example - private location

In this example, the request updates the private synthetic location from the POST request example. It changes the name of the location to Linz and adds the synthetic node with the ID of 353074222.

The API token is passed in the Authorization header.

The response code of 204 indicates that the update was successful.

You can download or copy the example request body to try it out on your own. Be sure to replace the list of nodes with nodes available in your environment. You can fetch the list of available nodes with the GET all nodes request.

Curl

curl -L -X PUT 'https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-493122BFA29674DC' \
-H 'Authorization: Api-Token abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
--data-raw '{
  "type": "PRIVATE",
  "name": "Linz",
  "countryCode": "AT",
  "regionCode": "04",
  "city": "Linz",
  "status": "ENABLED",
  "latitude": 48.306351,
  "longitude": 14.287399,
  "nodes": [
    "290433380",
    "353074222"
  ],
  "availabilityLocationOutage": false,
  "availabilityNodeOutage": false,
  "locationNodeOutageDelayInMillis": 5000
}
'

Request URL

https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-493122BFA29674DC

Request body

Download
{
  "type": "PRIVATE",
  "name": "Linz",
  "countryCode": "AT",
  "city": "Linz",
  "status": "ENABLED",
  "latitude": 48.306351,
  "longitude": 14.287399,
  "nodes": [
    "290433380",
    "353074222"
  ],
  "availabilityLocationOutage": false,
  "availabilityNodeOutage": false,
  "locationNodeOutageDelayInMillis": 5000
}

Response code

204

Example - public location

In this example, the request disables the public location with the ID of SYNTHETIC_LOCATION-0000000000000273.

The API token is passed in the Authorization header.

The response code of 204 indicates that the update was successful.

Curl

curl -L -X PUT 'https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000273' \
-H 'Authorization: Api-Token abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
--data-raw '{
  "type": "PUBLIC",
  "status": "DISABLED"  
}
'

Request URL

https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000273

Request body

{
  "type": "PUBLIC",
  "status": "DISABLED"  
}

Response code

204