Synthetic locations API v2 - 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 `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	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: `PUBLIC` -> PublicSyntheticLocation `PRIVATE` -> PrivateSyntheticLocation `CLUSTER` -> PrivateSyntheticLocation The element can hold these values `CLUSTER` `PRIVATE` `PUBLIC`	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, `AT` for Austria or `PL` for Poland).	optional
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.	optional
city	string	The city of the location.	optional
latitude	number	The latitude of the location in `DDD.dddd` format.	required
longitude	number	The longitude of the location in `DDD.dddd` format.	required
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`	optional
geoLocationId	string	The Dynatrace GeoLocation ID of the location.	optional

json
{
  "entityId": "SYNTHETIC_LOCATION-F23EE93163E76BE2",
  "type": "PRIVATE",
  "status": "ENABLED",
  "name": "Sample synthetic location",
  "countryCode": "PL",
  "regionCode": "82",
  "city": "Gdańsk",
  "latitude": 54.389,
  "longitude": 18.6255,
  "nodes": [
    "2131628184"
  ],
  "availabilityLocationOutage": false,
  "availabilityNodeOutage": false,
  "locationNodeOutageDelayInMillis": 5000,
  "geoLocationId": "GEOLOCATION-AA22893EF461842C"
}

PUBLIC

PublicSyntheticLocation

ParametersJSON model

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	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: `PUBLIC` -> PublicSyntheticLocation `PRIVATE` -> PrivateSyntheticLocation `CLUSTER` -> PrivateSyntheticLocation The element can hold these values `CLUSTER` `PRIVATE` `PUBLIC`	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, `AT` for Austria or `PL` for Poland).	optional
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.	optional
city	string	The city of the location.	optional
latitude	number	The latitude of the location in `DDD.dddd` format.	required
longitude	number	The longitude of the location in `DDD.dddd` format.	required
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`	optional

json
{
  "name": "US Central",
  "entityId": "SYNTHETIC_LOCATION-00000000000001A5",
  "type": "PUBLIC",
  "cloudPlatform": "GOOGLE_CLOUD",
  "ips": [
    "210.6.226.150",
    "185.77.153.103",
    "153.242.5.43"
  ],
  "stage": "BETA",
  "status": "ENABLED",
  "capabilities": [
    "BROWSER",
    "HTTP"
  ],
  "geoLocationId": "GEOLOCATION-AA22893EF461842C"
}

Synthetic locations API v2 - JSON models

Variations of the SyntheticLocation object

CLUSTER and PRIVATE

The SyntheticLocation object

PUBLIC

The SyntheticLocation object

Variations of the `SyntheticLocation` object

The `SyntheticLocation` object

The `SyntheticLocation` object