• Home
  • Dynatrace API
  • Environment
  • Synthetic v1
  • Locations
  • JSON models

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

The PrivateSyntheticLocation object

ElementTypeDescription
nodesstring[]

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.

availabilityLocationOutageboolean

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

Can be null.

availabilityNodeOutageboolean

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.

locationNodeOutageDelayInMinutesinteger

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.

availabilityNotificationsEnabledboolean

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

Can be null.

autoUpdateChromiumboolean

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.

ElementTypeDescription
entityIdstring

The Dynatrace entity ID of the location.

typestring

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
namestring

The name of the location.

countryCodestring

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.

regionCodestring

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.

citystring

The city of the location.

Can be null.

latitudenumber

The latitude of the location in DDD.dddd format.

longitudenumber

The longitude of the location in DDD.dddd format.

statusstring

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

The PublicSyntheticLocation object

ElementTypeDescription
cloudPlatformstring

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.

ipsstring[]

The list of IP addresses assigned to the location.

Can be null.

stagestring

The stage of the location.

The element can hold these values
  • BETA
  • COMING_SOON
  • DELETED
  • GA

Can be null.

browserTypestring

The type of the browser the location is using to execute browser monitors.

Can be null.

browserVersionstring

The version of the browser the location is using to execute browser monitors.

Can be null.

capabilitiesstring[]

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.

ElementTypeDescription
entityIdstring

The Dynatrace entity ID of the location.

typestring

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
namestring

The name of the location.

countryCodestring

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.

regionCodestring

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.

citystring

The city of the location.

Can be null.

latitudenumber

The latitude of the location in DDD.dddd format.

longitudenumber

The longitude of the location in DDD.dddd format.

statusstring

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" }
Related topics
  • Synthetic Monitoring

    Learn about Synthetic Monitoring and how to create a single-URL browser monitor, a browser clickpath, or an HTTP monitor.