Retrieve a synthetic location in Dynatrace with the Synthetic API by specifying the location ID and viewing its properties.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/synthetic/v1/locations/{location-id} |
You use the location-id endpoint to get the properties of a specific synthetic location. The path parameter location-id identifies the location, and the response returns its synthetic location parameters.
To execute this request, you need a platform token or OAuth access token with synthetic:locations:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| location-id | string | The ID of the required location. | path | Required |
| Code | Type | Description |
|---|---|---|
| 200 | Synthetic | Success. The response contains parameters of the synthetic location. |
| 4XX | Error | Client side error. |
| 5XX | Error | Server side error. |
SyntheticPublicLocationDto objectConfiguration of a public synthetic location.
| Element | Type | Description |
|---|---|---|
| browserType | string | The type of the browser the location is using to execute browser monitors. |
| browserVersion | string | The version of the browser the location is using to execute browser monitors. |
| capabilities | string[] | A list of location capabilities. |
| city | string | The city of the location. |
| cloudPlatform | string | The cloud provider where the location is hosted. The element can hold these values
|
| countryCode | string | The country code of the location. To fetch the list of available country codes, use the GET all countries request. |
| countryName | string | The country name of the location. |
| geoLocationId | string | The Dynatrace GeoLocation ID. |
| id | string | The Dynatrace Location ID. |
| ips | string[] | The list of IP addresses assigned to the location. |
| latitude | number | The latitude of the location in |
| longitude | number | The longitude of the location in |
| name | string | The name of the location. |
| regionCode | string | The region code of the location. To fetch the list of available region codes, use the GET regions of the country request. |
| regionName | string | The region name of the location. |
| stage | string | The stage of the location. The element can hold these values
|
| status | string | The status of the location:
The element can hold these values
|
| type | string | -The element can hold these values
|
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 |
|---|---|---|
| autoUpdateChromium | boolean | Non-containerized location property. Auto upgrade of Chromium is enabled ( |
| availabilityLocationOutage | boolean | Alerting for location outage is enabled ( |
| availabilityNodeOutage | boolean | Alerting for node outage is enabled ( |
| availabilityNotificationsEnabled | boolean | Notifications for location and node outage are enabled ( |
| browserExecutionSupported | boolean | Containerized location property. Boolean value describes if browser monitors will be executed on this location:
|
| city | string | The city of the location. |
| countryCode | string | The country code of the location. To fetch the list of available country codes, use the GET all countries request. |
| countryName | string | The country name of the location. |
| deploymentType | string | The deployment type of the location:
The element can hold these values
|
| fipsMode | string | Containerized location property indicating whether FIPS mode is enabled on this location:
The element can hold these values
|
| geoLocationId | string | The Dynatrace GeoLocation ID. |
| id | string | The Dynatrace Location ID. |
| latitude | number | The latitude of the location in |
| locationNodeOutageDelayInMinutes | integer | Alert if location or node outage lasts longer than X minutes. \n\n Only applicable when |
| longitude | number | The longitude of the location in |
| maxActiveGateCount | integer | Containerized location property. The maximum number of ActiveGates deployed for the location (required for a Kubernetes location). |
| minActiveGateCount | integer | Containerized location property. The minimum number of ActiveGates deployed for the location (required for a Kubernetes location). |
| namExecutionSupported | boolean | Containerized location property. Boolean value describes if icmp monitors will be executed on this location:
|
| name | string | The name of the location. |
| nodeNames | object | A mapping id to name of the nodes belonging to the location. |
| 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
|
| 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. |
| regionCode | string | The region code of the location. To fetch the list of available region codes, use the GET regions of the country request. |
| regionName | string | The region name of the location. |
| status | string | The status of the location:
The element can hold these values
|
| type | string | -The element can hold these values
|
| useNewKubernetesVersion | boolean | Containerized location property. Boolean value describes which kubernetes version will be used:
|
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
|
{"browserType": "Chrome","browserVersion": "69.0.3497.81","capabilities": ["BROWSER","HTTP"],"city": "Amazon US East (N. Virginia)","cloudPlatform": "AMAZON_EC2","countryCode": "US","id": "GEOLOCATION-95196F3C9A4F4215","ips": ["134.189.153.97","134.189.153.98"],"latitude": 39.0436,"longitude": -77.4875,"name": "Amazon US East","regionCode": "VA","stage": "GA","status": "ENABLED","type": "PUBLIC"}
{"error": {"code": 1,"details": {"type": "constraintViolation"},"message": "string"}}