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 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.
Element | Type | Description |
---|---|---|
autoUpdateChromium | boolean | Auto upgrade of Chromium is enabled ( |
availabilityLocationOutage | boolean | Alerting for location outage is enabled ( |
availabilityNodeOutage | boolean | Alerting for node outage is enabled ( |
availabilityNotificationsEnabled | boolean | Notifications for location and node outage are enabled ( |
deploymentType | string | The deployment type of the location:
The element can hold these values
|
locationNodeOutageDelayInMinutes | integer | Alert if location or node outage lasts longer than X minutes. \n\n Only applicable when |
nodes | string[] | A list of synthetic nodes belonging to the location. You can retrieve the list of available nodes with the GET all nodes call. |
useNewKubernetesVersion | boolean | Boolean value describes which kubernetes version will be used:
|
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
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.
Element | Type | Description |
---|---|---|
browserType | string | The type of the browser the location is using to execute browser monitors. |
browserVersion | string | The version of the browser the location is using to execute browser monitors. |
capabilities | string[] | A list of location capabilities. |
cloudPlatform | string | The cloud provider where the location is hosted. The element can hold these values
|
ips | string[] | The list of IP addresses assigned to the location. |
stage | string | The stage of the location. The element can hold these values
|
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"
}
- Synthetic Monitoring
Learn about Synthetic Monitoring and how to create a single-URL browser monitor, a browser clickpath, or an HTTP monitor.