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

PrivateSyntheticLocation

ParametersJSON model

The `PrivateSyntheticLocation` object

Element	Type	Description
nodes	string[]	A list of synthetic nodes belonging to the location. You can retrieve the list of available nodes with the GET all nodes call. Can be `null`.
availabilityLocationOutage	boolean	The alerting of location outage is enabled (`true`) or disabled (`false`). Can be `null`.
availabilityNodeOutage	boolean	The alerting of node outage is enabled (`true`) or disabled (`false`). If enabled, the outage of any node in the location triggers an alert. Can be `null`.
locationNodeOutageDelayInMinutes	integer	Alert if the location or node outage lasts longer than X minutes. Only applicable when availabilityLocationOutage or availabilityNodeOutage is set to `true`. Can be `null`.
availabilityNotificationsEnabled	boolean	The notifications of location and node outage is enabled (`true`) or disabled (`false`). Can be `null`.
autoUpdateChromium	boolean	Auto upgrade of Chromium is enabled (`true`) or disabled (`false`). Can be `null`.

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
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: `PUBLIC` -> PublicSyntheticLocation `PRIVATE` -> PrivateSyntheticLocation `CLUSTER` -> PrivateSyntheticLocation The element can hold these values `CLUSTER` `PRIVATE` `PUBLIC`
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). Can be `null`.
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. Can be `null`.
city	string	The city of the location. Can be `null`.
latitude	number	The latitude of the location in `DDD.dddd` format.
longitude	number	The longitude of the location in `DDD.dddd` format.
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. The element can hold these values `DISABLED` `ENABLED` `HIDDEN` Can be `null`.

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

PublicSyntheticLocation

ParametersJSON model

The `PublicSyntheticLocation` object

Element	Type	Description
cloudPlatform	string	The cloud provider where the location is hosted. The element can hold these values `ALIBABA` `AMAZON_EC2` `AZURE` `DYNATRACE_CLOUD` `GOOGLE_CLOUD` `INTEROUTE` `OTHER` `UNDEFINED` Can be `null`.
ips	string[]	The list of IP addresses assigned to the location. Can be `null`.
stage	string	The stage of the location. The element can hold these values `BETA` `COMING_SOON` `DELETED` `GA` Can be `null`.
browserType	string	The type of the browser the location is using to execute browser monitors. Can be `null`.
browserVersion	string	The version of the browser the location is using to execute browser monitors. Can be `null`.
capabilities	string[]	A list of location capabilities. Can be `null`.

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
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: `PUBLIC` -> PublicSyntheticLocation `PRIVATE` -> PrivateSyntheticLocation `CLUSTER` -> PrivateSyntheticLocation The element can hold these values `CLUSTER` `PRIVATE` `PUBLIC`
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). Can be `null`.
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. Can be `null`.
city	string	The city of the location. Can be `null`.
latitude	number	The latitude of the location in `DDD.dddd` format.
longitude	number	The longitude of the location in `DDD.dddd` format.
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. The element can hold these values `DISABLED` `ENABLED` `HIDDEN` Can be `null`.

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

Synthetic locations API - JSON models

Variations of the SyntheticLocation object

CLUSTER and PRIVATE

The PrivateSyntheticLocation object

The SyntheticLocation object

PUBLIC

The PublicSyntheticLocation object

The SyntheticLocation object

Variations of the `SyntheticLocation` object

The `PrivateSyntheticLocation` object

The `SyntheticLocation` object

The `PublicSyntheticLocation` object

The `SyntheticLocation` object