Synthetic locations API - JSON models
Some JSON models of the Synthetic locations API vary depending on its type. Here you can find JSON models for each variation.
Variations of the SyntheticLocation object
The SyntheticLocation object is the base for synthetic locations. The actual set of fields depends on the type of the location.
CLUSTER and PRIVATE
The PrivateSyntheticLocation 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 | Required |
|---|---|---|---|
| entityId | string |
The Dynatrace entity ID of the location. |
required |
| type | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| name | string |
The name of the location. |
required |
| countryCode | string |
The country code of the location. Use the alpha-2 code of the ISO 3166-2 standard, (for example, |
optional |
| 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. |
optional |
| city | string |
The city of the location. |
optional |
| latitude | number |
The latitude of the location in |
required |
| longitude | number |
The longitude of the location in |
required |
| status | string |
The status of the location:
|
optional |
| nodes | string[] |
A list of synthetic nodes belonging to the location. |
required |
| availabilityLocationOutage | boolean |
The alerting of location outage is enabled ( |
optional |
| availabilityNodeOutage | boolean |
The alerting of node outage is enabled ( If enabled, the outage of any node in the location triggers an alert. |
optional |
| locationNodeOutageDelayInMinutes | integer |
Alert if the location or node outage lasts longer than X minutes. Only applicable when availabilityLocationOutage or availabilityNodeOutage is set to |
optional |
Possible values
Possible values for the status element:
- DISABLED
- ENABLED
- HIDDEN
Possible values for the type element:
- CLUSTER
- PRIVATE
- PUBLIC
{
"entityId": "SYNTHETIC_LOCATION-F23EE93163E76BE2",
"type": "PRIVATE",
"name": "Sample synthetic location",
"countryCode": "PL",
"regionCode": "82",
"city": "Gdańsk",
"latitude": 54.389,
"longitude": 18.6255,
"status": "ENABLED",
"nodes": [
"2131628184"
]
}
PUBLIC
The PublicSyntheticLocation 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 | Required |
|---|---|---|---|
| entityId | string |
The Dynatrace entity ID of the location. |
required |
| type | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| name | string |
The name of the location. |
required |
| countryCode | string |
The country code of the location. Use the alpha-2 code of the ISO 3166-2 standard, (for example, |
optional |
| 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. |
optional |
| city | string |
The city of the location. |
optional |
| latitude | number |
The latitude of the location in |
required |
| longitude | number |
The longitude of the location in |
required |
| status | string |
The status of the location:
|
optional |
| cloudPlatform | string |
The cloud provider where the location is hosted. The cloudPlatform element can hold these values. |
required |
| ips | string[] |
The list of IP addresses assigned to the location. |
required |
| stage | string |
The stage of the location. The stage element can hold these values. |
required |
| browserType | string |
The type of the browser the location is using to execute browser monitors. |
required |
| browserVersion | string |
The version of the browser the location is using to execute browser monitors. |
required |
| capabilities | string[] |
A list of location capabilities. |
optional |
Possible values
Possible values for the stage element:
- BETA
- COMING_SOON
- GA
Possible values for the cloudPlatform element:
- ALIBABA
- AMAZON_EC2
- AZURE
- DYNATRACE_CLOUD
- GOOGLE_CLOUD
- INTEROUTE
- OTHER
- PHYSICAL
- UNDEFINED
Possible values for the status element:
- DISABLED
- ENABLED
- HIDDEN
Possible values for the type element:
- CLUSTER
- PRIVATE
- PUBLIC
{
"name": "US Central",
"entityId": "GEOLOCATION-AA22893EF461842C",
"type": "PUBLIC",
"cloudPlatform": "GOOGLE_CLOUD",
"ips": [
"200.198.18.147",
"186.202.218.192",
"221.120.251.140"
],
"stage": "GA",
"status": "ENABLED"
}