Synthetic locations API - POST a location
We have a new version of this API—Synthetic API v2. Check it out!
Creates a new private Synthetic location. For more details about synthetic location creation, see Create a private Synthetic location.
The request consumes and produces an application/json payload.
| POST | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/locations |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v1/synthetic/locations | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/locations |
Authentication
To execute this request, you need an access token with ExternalSyntheticIntegration scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameter
To find all model variations that depend on the type of the model, see JSON models.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| body | Synthetic | The JSON body of the request. Contains parameters of the new private synthetic location. | body | optional |
Request body objects
The SyntheticLocation object
Configuration of a synthetic location.
countryCode, regionCode, city parameters are optional as they can be retrieved based on latitude and longitude of location.
The actual set of fields depends on the type of the location. Find the list of actual objects in the description of the type field or see Synthetic locations API v2 - JSON models.
| Element | Type | Description | Required |
|---|---|---|---|
| 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 |
| availabilityLocationOutage | boolean | The alerting of location outage is enabled ( | optional |
| availabilityNodeOutage | boolean | The alerting of node outage is enabled ( If enabled, the outage of any node in the location triggers an alert. | optional |
| locationNodeOutageDelayInMinutes | integer | Alert if the location or node outage lasts longer than X minutes. Only applicable when availabilityLocationOutage or availabilityNodeOutage is set to | optional |
| availabilityNotificationsEnabled | boolean | The notifications of location and node outage is enabled ( | optional |
| deploymentType | string | The deployment type of the location:
| optional |
| autoUpdateChromium | boolean | Auto upgrade of Chromium is enabled ( | optional |
Request body JSON model
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{
"nodes": [
"string"
],
"availabilityLocationOutage": true,
"availabilityNodeOutage": true,
"locationNodeOutageDelayInMinutes": 1,
"availabilityNotificationsEnabled": true,
"deploymentType": "KUBERNETES",
"autoUpdateChromium": true
}Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Entity | Success |
Response body objects
The EntityIdDto object
A DTO for entity ID.
| Element | Type | Description |
|---|---|---|
| entityId | string | Entity ID to be transferred |
Response body JSON model
{
"entityId": "string"
}Example
In this example, the request creates a new private Synthetic location. This location lies in Linz, Austria. It uses the synthetic node with the ID of 93302281.
The API token is passed in the Authorization header.
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 POST \
https://mySampleEnv.live.dynatrace.com/api/v1/synthetic/locations \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
-H 'Content-Type: application/json' \
-d '{
"type": "PRIVATE",
"name": "REST example - Linz",
"countryCode": "AT",
"regionCode": "AU04",
"city": "Linz",
"latitude": 48.306351,
"longitude": 14.287399,
"nodes": [
"93302281"
]
}
'Request URL
https://mySampleEnv.live.dynatrace.com/api/v1/synthetic/locationsRequest body
{
"type": "PRIVATE",
"name": "REST example - Linz",
"countryCode": "AT",
"regionCode": "AU04",
"city": "Linz",
"latitude": 48.306351,
"longitude": 14.287399,
"nodes": ["93302281"]
}
Response body
{
"entityId": "SYNTHETIC_LOCATION-8F419D1B53639A45"
}Response code
200