• Home
  • Dynatrace Managed
  • Cluster API
  • Cluster API v2
  • Synthetic locations and nodes
  • GET a location

Synthetic locations API v2 - GET a location (Dynatrace Managed)

This API call gets the parameters of the specified location. The request produces an application/json payload.

Authentication

To execute this request, you need the Service Provider API (ServiceProviderAPI) permission assigned to your API token. Generate your API token via Cluster Management Console (CMC). To learn how to obtain and use it, see Cluster API - Authentication.

Endpoint

/api/cluster/v2/synthetic/locations

Parameters

ParameterTypeDescriptionInRequired
locationIdstring

The Dynatrace entity ID of the required location.

pathrequired

Response

Response codes

CodeTypeDescription
200SyntheticLocation

Success. The response contains parameters of the synthetic location.

Response 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.

ElementTypeDescription
entityIdstring

The Dynatrace entity ID of the location.

typestring

Defines the actual set of fields depending on the value. See one of the following objects:

  • PUBLIC -> PublicSyntheticLocation
  • PRIVATE -> PrivateSyntheticLocation
  • CLUSTER -> PrivateSyntheticLocation
The element can hold these values
  • CLUSTER
  • PRIVATE
  • PUBLIC
namestring

The name of the location.

countryCodestring

The country code of the location.

To fetch the list of available country codes, use the GET all countries request.

regionCodestring

The region code of the location.

To fetch the list of available region codes, use the GET regions of the country request.

citystring

The city of the location.

latitudenumber

The latitude of the location in DDD.dddd format.

longitudenumber

The longitude of the location in DDD.dddd format.

statusstring

The status of the location:

  • ENABLED: The location is displayed as active in the UI. You can assign monitors to the location.
  • DISABLED: The location is displayed as inactive in the UI. You can't assign monitors to the location. Monitors already assigned to the location will stay there and will be executed from the location.
  • HIDDEN: The location is not displayed in the UI. You can't assign monitors to the location. You can only set location as HIDDEN when no monitor is assigned to it.
The element can hold these values
  • DISABLED
  • ENABLED
  • HIDDEN
geoLocationIdstring

The Dynatrace GeoLocation ID of the location.

Response body JSON model

json
{ "entityId": "string", "type": "CLUSTER", "name": "string", "countryCode": "string", "regionCode": "string", "city": "string", "latitude": 1, "longitude": 1, "status": "DISABLED", "geoLocationId": "string" }

Response format

To find all model variations that depend on the type of the model, see JSON models.

Response codes

CodeTypeDescription
200SyntheticLocation

Success. The response contains parameters of the synthetic location.

Response 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.

ElementTypeDescription
entityIdstring

The Dynatrace entity ID of the location.

typestring

Defines the actual set of fields depending on the value. See one of the following objects:

  • PUBLIC -> PublicSyntheticLocation
  • PRIVATE -> PrivateSyntheticLocation
  • CLUSTER -> PrivateSyntheticLocation
The element can hold these values
  • CLUSTER
  • PRIVATE
  • PUBLIC
namestring

The name of the location.

countryCodestring

The country code of the location.

To fetch the list of available country codes, use the GET all countries request.

regionCodestring

The region code of the location.

To fetch the list of available region codes, use the GET regions of the country request.

citystring

The city of the location.

latitudenumber

The latitude of the location in DDD.dddd format.

longitudenumber

The longitude of the location in DDD.dddd format.

statusstring

The status of the location:

  • ENABLED: The location is displayed as active in the UI. You can assign monitors to the location.
  • DISABLED: The location is displayed as inactive in the UI. You can't assign monitors to the location. Monitors already assigned to the location will stay there and will be executed from the location.
  • HIDDEN: The location is not displayed in the UI. You can't assign monitors to the location. You can only set location as HIDDEN when no monitor is assigned to it.
The element can hold these values
  • DISABLED
  • ENABLED
  • HIDDEN
geoLocationIdstring

The Dynatrace GeoLocation ID of the location.

Response body JSON model

json
{ "entityId": "string", "type": "CLUSTER", "name": "string", "countryCode": "string", "regionCode": "string", "city": "string", "latitude": 1, "longitude": 1, "status": "DISABLED", "geoLocationId": "string" }

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

bash
curl -X GET \ https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000064 \ -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

plaintext
https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-0000000000000064

Response body

json
{ "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

bash
curl -X GET \ https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-BB5EE23C1D48AFF5 \ -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

plaintext
https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-BB5EE23C1D48AFF5

Response body

json
{ "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

Related topics
  • Synthetic Monitoring

    Learn about Synthetic Monitoring and how to create a single-URL browser monitor, a browser clickpath, or an HTTP monitor.