Synthetic locations API v2 - GET a location
Gets parameters of the specified location.
The request produces an application/json
payload.
Endpoint
/api/cluster/v2/synthetic/locations
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
locationId | string |
The Dynatrace entity ID of the required location. |
path | required |
Response
Response codes
Code | Description |
---|---|
200 | Success. The response contains parameters of the synthetic location. |
Response body
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.
Element | Type | Description |
---|---|---|
entityId | string | The Dynatrace entity ID of the location. |
type | string | Defines the actual set of fields depending on the value. See one of the following objects:
|
name | string | The name of the location. |
countryCode | string | The country code of the location. Use the alpha-2 code of the ISO 3166-2 standard, (for example, |
regionCode | string | The region code of the location. For the USA or Canada use ISO 3166-2 state codes (without For the rest of the world use FIPS 10-4 codes. |
city | string | The city of the location. |
latitude | number | The latitude of the location in |
longitude | number | The longitude of the location in |
status | string | The status of the location:
|
{
"entityId": "string",
"type": "CLUSTER",
"name": "string",
"countryCode": "string",
"regionCode": "string",
"city": "string",
"latitude": "number",
"longitude": "number",
"status": "DISABLED"
}
Response format
To find all model variations that depend on the type of the model, see JSON models.
Response codes
Code | Description |
---|---|
200 | Success. The response contains parameters of the synthetic location. |
Response body
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.
Element | Type | Description |
---|---|---|
entityId | string | The Dynatrace entity ID of the location. |
type | string | Defines the actual set of fields depending on the value. See one of the following objects:
|
name | string | The name of the location. |
countryCode | string | The country code of the location. Use the alpha-2 code of the ISO 3166-2 standard, (for example, |
regionCode | string | The region code of the location. For the USA or Canada use ISO 3166-2 state codes (without For the rest of the world use FIPS 10-4 codes. |
city | string | The city of the location. |
latitude | number | The latitude of the location in |
longitude | number | The longitude of the location in |
status | string | The status of the location:
|
{
"entityId": "string",
"type": "CLUSTER",
"name": "string",
"countryCode": "string",
"regionCode": "string",
"city": "string",
"latitude": "number",
"longitude": "number",
"status": "DISABLED"
}
Example - public location
In this example, the request gets the details of the Amazon US East (N. Virginia) public location, which has the ID of SYNTHETIC_LOCATION-0000000000000064.
Curl
curl -X GET \
https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000064 \
-H 'Authorization: Api-Token abcdefjhij1234567890'
Request URL
https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000064
Response body
{
"entityId": "SYNTHETIC_LOCATION-0000000000000064",
"type": "PUBLIC",
"name": "Gdańsk",
"countryCode": "PL",
"regionCode": "EU",
"city": "Gdańsk",
"latitude": 54.399078,
"longitude": 18.576557,
"status": "ENABLED",
"cloudPlatform": "OTHER",
"ips": [
"120.157.221.247",
"172.158.6.93",
"197.136.70.30",
"227.53.205.237",
"131.123.197.12"
],
"stage": "GA",
"browserType": "Chrome",
"browserVersion": "83.0.4103.61",
"capabilities": [
"BROWSER",
"HTTP"
],
"geoLocationId": "GEOLOCATION-0A41430434C388A9"
}
Response code
200
Example - private location
In this example, the request gets the details of the Linz HTTP private location, which has the ID of SYNTHETIC_LOCATION-BB5EE23C1D48AFF5.
Curl
curl -X GET \
https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-BB5EE23C1D48AFF5 \
-H 'Authorization: Api-Token abcdefjhij1234567890'
Request URL
https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-BB5EE23C1D48AFF5
Response body
{
"entityId": "SYNTHETIC_LOCATION-BB5EE23C1D48AFF5",
"type": "PRIVATE",
"name": "Linz HTTP",
"countryCode": "AT",
"regionCode": "04",
"city": "Linz",
"latitude": 48.306351,
"longitude": 14.287399,
"status": "ENABLED",
"nodes": [
"137829320"
],
"availabilityLocationOutage": false,
"availabilityNodeOutage": false,
"locationNodeOutageDelayInMillis": 3000,
"geoLocationId": "GEOLOCATION-427705B3488A4C45"
}
Response code
200