List synthetic locations in Dynatrace with the Synthetic API, filtering by cloud platform, type, or capability to return matching public and private locations.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/synthetic/v1/locations |
Use the cloud-platform, type, and capability query parameters to narrow the set of synthetic locations returned by Dynatrace. The response includes all matching public and private locations available for your environment.
To execute this request, you need a platform token or OAuth access token with synthetic:locations:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| cloud-platform | string | Filters the resulting set of locations to those that are hosted on a specific cloud platform. The element can hold these values
| query | Optional |
| type | string | Filters the resulting set of locations to those of a specific type. The element can hold these values
| query | Optional |
| capability | string | Filters the resulting set of locations to those that support a specific capability. The element can hold these values
| query | Optional |
| Code | Type | Description |
|---|---|---|
| 200 | Synthetic | Success |
| 4XX | Error | Client side error. |
| 5XX | Error | Server side error. |
SyntheticLocationsResponse objectA list of synthetic locations.
| Element | Type | Description |
|---|---|---|
| locations | Location | A list of synthetic locations. |
LocationCollectionElementDto 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 The element can hold these values
|
| deploymentType | string | Location's deployment type. The element can hold these values
|
| geoCity | string | Location's city. |
| geoContinent | string | Location's continent. |
| geoCountry | string | Location's country. |
| geoLatitude | number | Location's latitude. |
| geoLocationId | string | The Dynatrace GeoLocation ID. |
| geoLongitude | number | Location's longitude. |
| id | string | The Dynatrace Location ID. |
| ips | string[] | The list of IP addresses assigned to the location. Only applicable to |
| lastModificationTimeMillis | integer | The timestamp of the last modification of the location, in milliseconds since the Unix epoch. |
| name | string | The name of the location. |
| 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. |
| stage | string | The release stage of the location. The element can hold these values
|
| status | string | The status of the location. The element can hold these values
|
| type | string | The type of the location. The element can hold these values
|
ErrorResponseEnvelope objectEncloses the encountered error.
| Element | Type | Description |
|---|---|---|
| error | Error | Basic information of the encountered error. |
ErrorResponse objectBasic information of the encountered error.
| Element | Type | Description |
|---|---|---|
| code | integer | The returned HTTP status code. |
| details | Error | Detailed information of the error. |
| message | string | Description of the encountered error. |
ErrorResponseDetails objectDetailed information of the error.
| Element | Type | Description |
|---|---|---|
| type | string | Defines the actual set of fields depending on the value. See one of the following objects:
The element can hold these values
|
{"locations": [{"capabilities": ["BROWSER","HTTP"],"cloudPlatform": "AMAZON_EC2","geoCity": "Gdansk","geoContinent": "Europe","geoCountry": "Poland","geoLatitude": "54.399078369140625","geoLocationId": "GEOLOCATION-95196F3C9A4F4215","geoLongitude": "18.576557159423828","id": "SYNTHETIC_LOCATION-53F47ECB33907667","ips": ["134.189.153.97","134.189.153.98"],"name": "Gdansk","stage": "GA","status": "ENABLED","type": "PUBLIC"},{"geoLocationId": "GEOLOCATION-95196F3C9A4F4215","id": "SYNTHETIC_LOCATION-53F47ECB33907667","name": "My private location","status": "ENABLED","type": "PRIVATE"}]}
{"error": {"code": 1,"details": {"type": "constraintViolation"},"message": "string"}}