Synthetic locations API - JSON models

  • Reference
  • Published Jul 13, 2020

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.

countryCode, regionCode, city parameters are optional as they can be retrieved based on latitude and longitude of location.

ElementTypeDescription
autoUpdateChromiumboolean

Non-containerized location property. 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.

browserExecutionSupportedboolean

Containerized location property. Boolean value describes if browser monitors will be executed on this location:

  • false: Browser monitor executions disabled.
  • true: Browser monitor executions enabled.
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
fipsModestring

Containerized location property indicating whether FIPS mode is enabled on this location:

  • DISABLED: FIPS is not enabled on the location.
  • ENABLED: FIPS is enabled on the location.
  • ENABLED_WITH_CORPORATE_PROXY: FIPS with corporate proxy is enabled on this location. Default: DISABLED
  • DISABLED
  • ENABLED
  • ENABLED_WITH_CORPORATE_PROXY
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.

maxActiveGateCountinteger

Containerized location property. The maximum number of ActiveGates deployed for the location (required for a Kubernetes location).

minActiveGateCountinteger

Containerized location property. The minimum number of ActiveGates deployed for the location (required for a Kubernetes location).

namExecutionSupportedboolean

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

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

Containerized location property. The size of a containerized node deployed for the location (required for a Kubernetes location). Accepted values:

  • XS: extra small
  • S: small
  • M: medium The node size L is not supported in containerized locations.
  • M
  • S
  • UNSUPPORTED
  • XS
nodesstring[]

A list of synthetic nodes belonging to the location.

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

useNewKubernetesVersionboolean

Containerized location property. 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