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.
Some fields are inherited from the base SyntheticLocation object.
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 city of the location.
The country code of the location.
To fetch the list of available country codes, use the GET all countries request.
The country name of the location.
The deployment type of the location:
STANDARD: The location is deployed on Windows or Linux.KUBERNETES: The location is deployed on Kubernetes.KUBERNETESOPENSHIFTSTANDARDUNKNOWNThe Dynatrace entity ID of the location.
The Dynatrace GeoLocation ID of the location.
The latitude of the location in DDD.dddd format.
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.
The longitude of the location in DDD.dddd format.
Boolean value describes if icmp monitors will be executed on this location:
false: Icmp monitor executions disabled.true: Icmp monitor executions enabled.The name of the location.
A mapping id to name of the nodes belonging to the location.
A list of synthetic nodes belonging to the location.
You can retrieve the list of available nodes with the GET all nodes call.
The region code of the location.
To fetch the list of available region codes, use the GET regions of the country request.
The region name of the location.
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.DISABLEDENABLEDHIDDENCLUSTERPRIVATEPUBLICBoolean 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","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"}
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": "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"}