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

The PrivateSyntheticLocation object

Configuration of a synthetic 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:

  • PUBLIC -> PublicSyntheticLocation
  • PRIVATE -> PrivateSyntheticLocation
  • CLUSTER -> PrivateSyntheticLocation
required
name string

The name of the location.

required
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.
optional
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.

required
availabilityLocationOutage boolean

The alerting of location outage is enabled (true) or disabled (false).

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

optional
locationNodeOutageDelayInMinutes integer

Alert if the location or node outage lasts longer than X minutes.

Only applicable when availabilityLocationOutage or availabilityNodeOutage is set to true.

optional
availabilityNotificationsEnabled boolean

The notifications of location and node outage is enabled (true) or disabled (false).

optional
geoLocationId string

The Dynatrace GeoLocation ID of the location.

required

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:

  • PUBLIC -> PublicSyntheticLocation
  • PRIVATE -> PrivateSyntheticLocation
  • CLUSTER -> PrivateSyntheticLocation
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.
optional
cloudPlatform string

The cloud provider where the location is hosted.

required
ips string[]

The list of IP addresses assigned to the location.

required
stage string

The stage of the location.

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

Variations of the SyntheticLocationUpdate object

The SyntheticLocationUpdate object is the base for updates to synthetic locations. The actual set of fields depends on the type of the location.

PRIVATE

The SyntheticPrivateLocationUpdate object

The synthetic location update. This is a base object, the exact type depends on the value of the type field.

Element Type Description Required
type string

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

  • PUBLIC -> SyntheticPublicLocationUpdate
  • PRIVATE -> SyntheticPrivateLocationUpdate
optional
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.

required
name string

The name of the location.

required
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.
optional
availabilityLocationOutage boolean

The alerting of location outage is enabled (true) or disabled (false).

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

optional
locationNodeOutageDelayInMinutes integer

Alert if the location or node outage lasts longer than X minutes.

Only applicable when availabilityLocationOutage or availabilityNodeOutage is set to true.

optional
availabilityNotificationsEnabled boolean

The notifications of location and node outage is enabled (true) or disabled (false).

optional

PUBLIC

The SyntheticPublicLocationUpdate object

The synthetic location update. This is a base object, the exact type depends on the value of the type field.

Element Type Description Required
type string

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

  • PUBLIC -> SyntheticPublicLocationUpdate
  • PRIVATE -> SyntheticPrivateLocationUpdate
optional
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.
required