We have a new version of this API—Synthetic API v2. Check it out!
Lists all locations, public and private, and their parameters available for your environment.
The request produces an application/json
payload.
GET | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v1/synthetic/locations |
Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v1/synthetic/locations |
To execute this request, you need an access token with one of the following scopes:
DataExport
ExternalSyntheticIntegration
ReadSyntheticData
To learn how to obtain and use it, see Tokens and authentication.
Parameter | Type | Description | In | Required |
---|---|---|---|---|
cloudPlatform | string | Filters the resulting set of locations to those which are hosted on a specific cloud platform.
| query | optional |
type | string | Filters the resulting set of locations by a specific type.
| query | optional |
Code | Type | Description |
---|---|---|
200 | Synthetic | Success |
4XX | Error | Client side error. |
5XX | Error | Server side error. |
SyntheticLocations
objectA list of synthetic locations.
Element | Type | Description |
---|---|---|
locations | Location | A list of synthetic locations. |
LocationCollectionElement
objectA synthetic location.
Element | Type | Description |
---|---|---|
capabilities | string[] | The list of location's capabilities. |
cloudPlatform | string | The cloud provider where the location is hosted. Only applicable to
|
entityId | string | The Dynatrace entity ID of the location. |
ips | string[] | The list of IP addresses assigned to the location. Only applicable to |
name | string | The name of the location. |
stage | string | The release stage of the location.
|
status | string | The status of the location.
|
type | string | The type of the location.
|
{"locations": [{"capabilities": ["BROWSER","HTTP"],"cloudPlatform": "AMAZON_EC2","entityId": "GEOLOCATION-B8D793BCA914E0AF","ips": ["134.189.153.97","134.189.153.98"],"name": "Gdansk","stage": "GA","status": "ENABLED","type": "PUBLIC"},{"entityId": "SYNTHETIC_LOCATION-53F47ECB33907667","name": "My private location","status": "ENABLED","type": "PRIVATE"}]}
In this example, the request lists all synthetic locations available for the mySampleEnv environment.
The API token is passed in the Authorization header.
The result is truncated to three entries.
curl -X GET \https://mySampleEnv.live.dynatrace.com/api/v1/synthetic/locations \-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'
https://mySampleEnv.live.dynatrace.com/api/v1/synthetic/locations
{"locations": [{"name": "Amazon US East (N. Virginia)","entityId": "GEOLOCATION-95196F3C9A4F4215","type": "PUBLIC","cloudPlatform": "AMAZON_EC2","ips": ["134.189.153.97","134.189.153.98","134.189.153.99"]},{"name": "AWS Europe (London)","entityId": "GEOLOCATION-A9022AAFA0763F56","type": "PUBLIC","cloudPlatform": "AMAZON_EC2","ips": ["243.22.221.174","104.179.71.29"]},{"name": "Gdansk HTTP","entityId": "SYNTHETIC_LOCATION-9C75B59442498323","type": "PRIVATE"}]}
200