• 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

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
nodesstring[]

A list of synthetic nodes belonging to the location.

You can retrieve the list of available nodes with the GET all nodes call.

availabilityLocationOutageboolean

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

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.

locationNodeOutageDelayInMinutesinteger

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

Only applicable when availabilityLocationOutage or availabilityNodeOutage is set to true.

availabilityNotificationsEnabledboolean

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

deploymentTypestring

The deployment type of the location:

  • STANDARD: The location is deployed on Windows or Linux.
  • KUBERNETES: The location is deployed on Kubernetes.
The element can hold these values
  • KUBERNETES
  • OPENSHIFT
  • STANDARD
autoUpdateChromiumboolean

Auto upgrade of Chromium is enabled (true) or disabled (false).

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

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
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
ipsstring[]

The list of IP addresses assigned to the location.

stagestring

The stage of the location.

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

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

browserVersionstring

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

capabilitiesstring[]

A list of location capabilities.

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.