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 private synthetic location.

Some fields are inherited from the base SyntheticLocation object.

ElementTypeDescription
autoUpdateChromiumboolean

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

availabilityLocationOutageboolean

Alerting for location outage is enabled (true) or disabled (false). Supported only for private Synthetic locations.

availabilityNodeOutageboolean

Alerting for node outage is enabled (true) or disabled (false). \n\n If enabled, the outage of any node in the location triggers an alert. Supported only for private Synthetic locations.

availabilityNotificationsEnabledboolean

Notifications for location and node outage are enabled (true) or disabled (false). Supported only for private Synthetic locations.

citystring

The city of the location.

countryCodestring

The country code of the location.

To fetch the list of available country codes, use the GET all countries request.

countryNamestring

The country name of the location.

deploymentTypestring

The deployment type of the location:

  • STANDARD: The location is deployed on Windows or Linux.
  • KUBERNETES: The location is deployed on Kubernetes.
  • KUBERNETES
  • OPENSHIFT
  • STANDARD
  • UNKNOWN
entityIdstring

The Dynatrace entity ID of the location.

geoLocationIdstring

The Dynatrace GeoLocation ID of the location.

latitudenumber

The latitude of the location in DDD.dddd format.

locationNodeOutageDelayInMinutesinteger

Alert if location or node outage lasts longer than X minutes. \n\n Only applicable when availabilityLocationOutage or availabilityNodeOutage is set to true. Supported only for private Synthetic locations.

longitudenumber

The longitude of the location in DDD.dddd format.

namExecutionSupportedboolean

Boolean value describes if icmp monitors will be executed on this location:

  • false: Icmp monitor executions disabled.
  • true: Icmp monitor executions enabled.
namestring

The name of the location.

nodeNamesobject

A mapping id to name of the nodes belonging to the location.

nodesstring[]

A list of synthetic nodes belonging to the location.

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

regionCodestring

The region code of the location.

To fetch the list of available region codes, use the GET regions of the country request.

regionNamestring

The region name of the location.

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.
  • DISABLED
  • ENABLED
  • HIDDEN
typestring-
  • CLUSTER
  • PRIVATE
  • PUBLIC
useNewKubernetesVersionboolean

Boolean value describes which kubernetes version will be used:

  • false: Version 1.23+ that is older than 1.26
  • true: Version 1.26+.

PUBLIC

The PublicSyntheticLocation object

Configuration of a public synthetic location.

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

cloudPlatformstring

The cloud provider where the location is hosted.

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

  • BETA
  • COMING_SOON
  • DELETED
  • GA

Related topics