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

Dynatrace Managed Documentation

This page will soon be available only on the dedicated Dynatrace Managed Documentation site. Update your bookmarks.

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

Parameter	Type	Description	In	Required
locationId	string	The Dynatrace entity ID of the required location.	path	required

Response

Response codes

Code	Type	Description
200	SyntheticLocation	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.

Element	Type	Description
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.
entityId	string	The Dynatrace entity ID of the location.
geoLocationId	string	The Dynatrace GeoLocation ID 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.
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.
status	string	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. `DISABLED` `ENABLED` `HIDDEN`
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `PUBLIC` -> PublicSyntheticLocation `PRIVATE` -> PrivateSyntheticLocation `CLUSTER` -> PrivateSyntheticLocation `CLUSTER` `PRIVATE` `PUBLIC`

Response body JSON model

1{
2  "city": "string",
3  "countryCode": "string",
4  "entityId": "string",
5  "geoLocationId": "string",
6  "latitude": 1,
7  "longitude": 1,
8  "name": "string",
9  "regionCode": "string",
10  "status": "DISABLED",
11  "type": "CLUSTER"
12}

Response format

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

Response codes

Code	Type	Description
200	SyntheticLocation	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.

Element	Type	Description
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.
entityId	string	The Dynatrace entity ID of the location.
geoLocationId	string	The Dynatrace GeoLocation ID 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.
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.
status	string	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. `DISABLED` `ENABLED` `HIDDEN`
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `PUBLIC` -> PublicSyntheticLocation `PRIVATE` -> PrivateSyntheticLocation `CLUSTER` -> PrivateSyntheticLocation `CLUSTER` `PRIVATE` `PUBLIC`

Response body JSON model

1{
2  "city": "string",
3  "countryCode": "string",
4  "entityId": "string",
5  "geoLocationId": "string",
6  "latitude": 1,
7  "longitude": 1,
8  "name": "string",
9  "regionCode": "string",
10  "status": "DISABLED",
11  "type": "CLUSTER"
12}

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

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

Request URL

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

Response body

1{
2  "entityId": "SYNTHETIC_LOCATION-0000000000000064",
3  "type": "PUBLIC",
4  "name": "Gdańsk",
5  "countryCode": "PL",
6  "regionCode": "EU",
7  "city": "Gdańsk",
8  "latitude": 54.399078,
9  "longitude": 18.576557,
10  "status": "ENABLED",
11  "cloudPlatform": "OTHER",
12  "ips": [
13    "120.157.221.247",
14    "172.158.6.93",
15    "197.136.70.30",
16    "227.53.205.237",
17    "131.123.197.12"
18  ],
19  "stage": "GA",
20  "browserType": "Chrome",
21  "browserVersion": "83.0.4103.61",
22  "capabilities": [
23    "BROWSER",
24    "HTTP"
25  ],
26  "geoLocationId": "GEOLOCATION-0A41430434C388A9"
27}

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

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

Request URL

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

Response body

1{
2  "entityId": "SYNTHETIC_LOCATION-BB5EE23C1D48AFF5",
3  "type": "PRIVATE",
4  "name": "Linz HTTP",
5  "countryCode": "AT",
6  "regionCode": "04",
7  "city": "Linz",
8  "latitude": 48.306351,
9  "longitude": 14.287399,
10  "status": "ENABLED",
11  "nodes": [
12    "137829320"
13  ],
14  "availabilityLocationOutage": false,
15  "availabilityNodeOutage": false,
16  "locationNodeOutageDelayInMillis": 3000,
17  "geoLocationId": "GEOLOCATION-427705B3488A4C45"
18}

Response code

200

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

Authentication

Endpoint

Parameters

Response

Response codes

Response body objects

The SyntheticLocation object

Response body JSON model

Response format

Response codes

Response body objects

The SyntheticLocation object

Response body JSON model

Example - public location

Curl

Request URL

Response body

Response code

Example - private location

Curl

Request URL

Response body

Response code

Related topics

The `SyntheticLocation` object

The `SyntheticLocation` object