Synthetic locations API - PUT a location

Updates an existing private synthetic location.

The request consumes an application/json payload.

Early Adopter

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

PUT
  • Managed https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/locations/{locationId}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v1/synthetic/locations/{locationId}

Parameters

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 private synthetic location or the status of the location.

body optional

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 -> SyntheticLocationStatusUpdate
  • PRIVATE -> SyntheticPrivationLocationUpdate
The type element can hold these values.
optional

Possible values

Possible values for the type element in the SyntheticLocationUpdate object:

  • PUBLIC
  • PRIVATE

Response format

A successful request doesn't return any content.

Example

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.

Curl

curl -X PUT \
  https://mySampleEnv.live.dynatrace.com/api/v1/synthetic/locations/SYNTHETIC_LOCATION-8F419D1B53639A45 \
  -H 'Authorization: Api-Token abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \  
  -d '{
  "type": "PRIVATE",
  "name": "Linz",
  "countryCode": "AT",
  "regionCode": "AU04",
  "city": "Linz",
  "latitude": 48.306351,
  "longitude": 14.287399,
  "nodes": [
    "93302281",
    "353074222"
  ]
}
'

Request URL

https://mySampleEnv.live.dynatrace.com/api/v1/synthetic/locations/SYNTHETIC_LOCATION-8F419D1B53639A45

Request body

api-examples/synthetic/locations/put-location.json
Download
{
  "type": "PRIVATE",
  "name": "Linz",
  "countryCode": "AT",
  "regionCode": "AU04",
  "city": "Linz",
  "latitude": 48.306351,
  "longitude": 14.287399,
  "nodes": [
    "93302281",
    "353074222"
  ]
}

Response code

204