Synthetic locations API - GET all locations
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.
This request is an Early Adopter release and may be changed in non-compatible way.
GET |
|
Authentication
To execute this request, you need the Access problem and event feed, metrics, and topology (DataExport
) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.
Parameters
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 |
Response
Response codes
Code | Description |
---|---|
200 | Success |
Response body
The SyntheticLocations object
A list of synthetic locations.
Element | Type | Description |
---|---|---|
locations | LocationCollectionElement[] | A list of synthetic locations. |
The LocationCollectionElement object
A synthetic location.
Element | Type | Description |
---|---|---|
name | string | The name of the location. |
entityId | string | The Dynatrace entity ID of the location. |
type | string | The type of the location. |
cloudPlatform | string | The cloud provider where the location is hosted. Only applicable to |
ips | string[] | The list of IP addresses assigned to the location. Only applicable to |
stage | string | The release stage of the location. |
status | string | The status of the location. |
{
"locations": [
{
"name": "Gdansk",
"entityId": "GEOLOCATION-B8D793BCA914E0AF",
"type": "PUBLIC",
"cloudPlatform": "AMAZON_EC2",
"ips": [
"134.189.153.97",
"134.189.153.98"
],
"stage": "GA",
"status": "ENABLED",
"capabilities": [
"BROWSER",
"HTTP"
]
},
{
"name": "My private location",
"entityId": "SYNTHETIC_LOCATION-53F47ECB33907667",
"type": "PRIVATE",
"status": "ENABLED"
}
]
}
Example
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
curl -X GET \
https://mySampleEnv.live.dynatrace.com/api/v1/synthetic/locations \
-H 'Authorization: Api-Token abcdefjhij1234567890'
Request URL
https://mySampleEnv.live.dynatrace.com/api/v1/synthetic/locations
Response body
{
"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"
}
]
}
Response code
200