Some JSON models of the Synthetic locations API vary depending on its type. Here you can find JSON models for each variation.
SyntheticLocation objectThe SyntheticLocation object is the base for synthetic locations. The actual set of fields depends on the type of the location.
PrivateSyntheticLocation objectConfiguration of a private synthetic location.
countryCode, regionCode, city parameters are optional as they can be retrieved based on latitude and longitude of location.
Auto upgrade of Chromium is enabled (true) or disabled (false).
Alerting for location outage is enabled (true) or disabled (false). Supported only for private Synthetic locations.
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.
Notifications for location and node outage are enabled (true) or disabled (false). Supported only for private Synthetic locations.
The deployment type of the location:
STANDARD: The location is deployed on Windows or Linux.KUBERNETES: The location is deployed on Kubernetes.KUBERNETESOPENSHIFTSTANDARDUNKNOWNAlert 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.
Boolean value describes if icmp monitors will be executed on this location:
false: Icmp monitor executions disabled.true: Icmp monitor executions enabled.A list of synthetic nodes belonging to the location.
You can retrieve the list of available nodes with the GET all nodes call.
Boolean value describes which kubernetes version will be used:
false: Version 1.23+ that is older than 1.26true: Version 1.26+.{"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"]}
PublicSyntheticLocation objectConfiguration of a public synthetic location.
The type of the browser the location is using to execute browser monitors.
The version of the browser the location is using to execute browser monitors.
A list of location capabilities.
The cloud provider where the location is hosted.
ALIBABAAMAZON_EC2AZUREDYNATRACE_CLOUDGOOGLE_CLOUDINTEROUTEOTHERUNDEFINEDThe list of IP addresses assigned to the location.
The stage of the location.
BETACOMING_SOONDELETEDGA{"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"}