Synthetic locations API - GET a location

Gets parameters of the specified location.

The request produces an application/json payload.

This request is an early adopter release and may be changed in non compatible way.

GET
  • 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 required location.

path required

Response format

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 additional fields in one of these objects:

  • PUBLIC -> PublicSyntheticLocation
  • CLUSTER -> PrivateSyntheticLocation
  • PRIVATE -> PrivateSyntheticLocation
Element Type Description
entityId string

The Dynatrace entity ID of the location.

type string

The type of the location.

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, AT for Austria or PL for Poland).

regionCode string

The region code of the location.

For the USA or Canada use ISO 3166-2 state codes (without US- or CA- prefix), for example, VA for Virginia or OR for Oregon.

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 DDD.dddd format.

longitude number

The longitude of the location in DDD.dddd format.

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 GEOLOCATION-95196F3C9A4F4215.

Curl

curl -X GET \
  https://mySampleEnv.live.dynatrace.com/api/v1/synthetic/locations/GEOLOCATION-95196F3C9A4F4215 \
  -H 'Authorization: Api-Token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/v1/synthetic/locations/GEOLOCATION-95196F3C9A4F4215

Response body

{
  "entityId": "GEOLOCATION-95196F3C9A4F4215",
  "type": "PUBLIC",
  "name": "Amazon US East (N. Virginia)",
  "countryCode": "US",
  "regionCode": "VA",
  "city": "Amazon US East (N. Virginia)",
  "latitude": 39.0436,
  "longitude": -77.4875,
  "cloudPlatform": "AMAZON_EC2",
  "ips": [
    "134.189.153.97",
    "134.189.153.98",
    "134.189.153.99"
  ]
}

Response code

200

Example - private location

In this example, the request gets the details of the Gdansk HTTP private location, which has the ID of SYNTHETIC_LOCATION-95196F3C9A4F4215.

Curl

curl -X GET \
  https://mySampleEnv.live.dynatrace.com/api/v1/synthetic/locations/SYNTHETIC_LOCATION-95196F3C9A4F4215 \
  -H 'Authorization: Api-Token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/v1/synthetic/locations/SYNTHETIC_LOCATION-95196F3C9A4F4215

Response body

{
  "entityId": "SYNTHETIC_LOCATION-9C75B59442498323",
  "type": "PRIVATE",
  "name": "Gdansk HTTP",
  "countryCode": "PL",
  "regionCode": "82",
  "city": "Gdańsk",
  "latitude": 54.3449,
  "longitude": 18.6283,
  "nodes": [
    "2015649819",
    "3086117876"
  ]
}

Response code

200