• Home
  • API
  • Environment
  • Synthetic v2
  • Locations
  • JSON models

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

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

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

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

Boolean value describes which kubernetes version will be used:

  • false: Version 1.23+ that is older than 1.26
  • true: Version 1.26+.
json
{
  "entityId": "SYNTHETIC_LOCATION-F23EE93163E76BE2",
  "type": "PRIVATE",
  "status": "ENABLED",
  "name": "Sample synthetic location",
  "countryCode": "PL",
  "regionCode": "82",
  "city": "Gdańsk",
  "latitude": 54.389,
  "longitude": 18.6255,
  "nodes": [
    "2131628184"
  ],
  "availabilityLocationOutage": false,
  "availabilityNodeOutage": false,
  "locationNodeOutageDelayInMillis": 5000,
  "geoLocationId": "GEOLOCATION-AA22893EF461842C"
}

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

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
json
{
  "name": "US Central",
  "entityId": "SYNTHETIC_LOCATION-00000000000001A5",
  "type": "PUBLIC",
  "cloudPlatform": "GOOGLE_CLOUD",
  "ips": [
    "210.6.226.150",
    "185.77.153.103",
    "153.242.5.43"
  ],
  "stage": "BETA",
  "status": "ENABLED",
  "capabilities": [
    "BROWSER",
    "HTTP"
  ],
  "geoLocationId": "GEOLOCATION-AA22893EF461842C"
}
Related topics
  • Synthetic Monitoring

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