Create a private synthetic location in Dynatrace with the Synthetic API, using location details such as city, country, coordinates, and execution support.
| POST | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/synthetic/v1/locations |
You use the locations endpoint to create a new private synthetic location. The request body can include fields such as autoUpdateChromium, city, countryCode, countryName, deploymentType, geoLocationId, latitude, longitude, and browserExecutionSupported, and the response returns the new location ID.
To execute this request, you need a platform token or OAuth access token with synthetic:locations:write scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| body | Synthetic | The JSON body of the request. Contains parameters of the new private synthetic location. | body | Required |
SyntheticPrivateLocationDto objectConfiguration of a private synthetic location.
countryCode, regionCode, city parameters are optional as they can be retrieved based on latitude and longitude of location.
| Element | Type | Description | Required |
|---|---|---|---|
| autoUpdateChromium | boolean | Non-containerized location property. Auto upgrade of Chromium is enabled ( | Optional |
| availabilityLocationOutage | boolean | Alerting for location outage is enabled ( | Optional |
| availabilityNodeOutage | boolean | Alerting for node outage is enabled ( | Optional |
| availabilityNotificationsEnabled | boolean | Notifications for location and node outage are enabled ( | Optional |
| browserExecutionSupported | boolean | Containerized location property. Boolean value describes if browser monitors will be executed on this location:
| Optional |
| city | string | The city of the location. | Optional |
| countryCode | string | The country code of the location. To fetch the list of available country codes, use the GET all countries request. | Optional |
| countryName | string | The country name of the location. | Optional |
| deploymentType | string | The deployment type of the location:
The element can hold these values
| Optional |
| fipsMode | string | Containerized location property indicating whether FIPS mode is enabled on this location:
The element can hold these values
| Optional |
| geoLocationId | string | The Dynatrace GeoLocation ID. | Optional |
| id | string | The Dynatrace Location ID. | Optional |
| latitude | number | The latitude of the location in | Required |
| locationNodeOutageDelayInMinutes | integer | Alert if location or node outage lasts longer than X minutes. \n\n Only applicable when | Optional |
| longitude | number | The longitude of the location in | Required |
| maxActiveGateCount | integer | Containerized location property. The maximum number of ActiveGates deployed for the location (required for a Kubernetes location). | Optional |
| minActiveGateCount | integer | Containerized location property. The minimum number of ActiveGates deployed for the location (required for a Kubernetes location). | Optional |
| namExecutionSupported | boolean | Containerized location property. Boolean value describes if icmp monitors will be executed on this location:
| Optional |
| name | string | The name of the location. | Required |
| nodeNames | object | A mapping id to name of the nodes belonging to the location. | Optional |
| nodeSize | string | Containerized location property. The size of a containerized node deployed for the location (required for a Kubernetes location). Accepted values:
The element can hold these values
| Optional |
| nodes | string[] | A list of synthetic nodes belonging to the location. You can retrieve the list of available nodes with the GET all nodes call. | Optional |
| regionCode | string | The region code of the location. To fetch the list of available region codes, use the GET regions of the country request. | Optional |
| regionName | string | The region name of the location. | Optional |
| status | string | The status of the location:
The element can hold these values
| Optional |
| type | string | -The element can hold these values
| Required |
| useNewKubernetesVersion | boolean | Containerized location property. Boolean value describes which kubernetes version will be used:
| Optional |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"autoUpdateChromium": true,"availabilityLocationNodeOutageDelayInMinutes": 5,"availabilityLocationOutage": false,"availabilityNodeOutage": false,"availabilityNotificationsEnabled": true,"deploymentType": "STANDARD","fipsMode": "DISABLED","latitude": 48.306351,"longitude": 14.287399,"maxActiveGateCount": 5,"minActiveGateCount": 2,"name": "Linz Location","nodeSize": "S","nodes": ["93302281"],"status": "ENABLED","type": "PRIVATE"}
| Code | Type | Description |
|---|---|---|
| 201 | Synthetic | Success. The private location has been created. The response contains the ID of the new location. |
| 4XX | Error | Client side error. |
| 5XX | Error | Server side error. |
SyntheticLocationIdsResponse objectA Response for synthetic Location IDs (Smartscape ID + GeoLocation ID).
| Element | Type | Description |
|---|---|---|
| geoLocationId | string | GeoLocation ID of the synthetic location. |
| id | string | Smartscape ID of the synthetic location. |
ErrorResponseEnvelope objectEncloses the encountered error.
| Element | Type | Description |
|---|---|---|
| error | Error | Basic information of the encountered error. |
ErrorResponse objectBasic information of the encountered error.
| Element | Type | Description |
|---|---|---|
| code | integer | The returned HTTP status code. |
| details | Error | Detailed information of the error. |
| message | string | Description of the encountered error. |
ErrorResponseDetails objectDetailed information of the error.
| Element | Type | Description |
|---|---|---|
| type | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
{"geoLocationId": "string","id": "string"}
{"error": {"code": 1,"details": {"type": "constraintViolation"},"message": "string"}}