Synthetic locations API v2 - GET all locations (Dynatrace Managed)

This API call lists all locations, public and private, and their parameters available for your environment. The request produces an application/json payload.

Authentication

To execute this request, you need the Service Provider API (ServiceProviderAPI) permission assigned to your API token. Generate your API token via Cluster Management Console (CMC). To learn how to obtain and use it, see Cluster API - Authentication.

Endpoint

/api/cluster/v2/synthetic/locations

Parameters

Parameter	Type	Description	In	Required
cloudPlatform	string	Filters the resulting set of locations to those which are hosted on a specific cloud platform. The element can hold these values `AWS` `AZURE` `ALIBABA` `GOOGLE_CLOUD` `OTHER`	query	optional
type	string	Filters the resulting set of locations to those of a specific type. The element can hold these values `PUBLIC` `PRIVATE`	query	optional

Response

Response codes

Code	Type	Description
200	SyntheticLocations	Success

Response body objects

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. The element can hold these values `CLUSTER` `PRIVATE` `PUBLIC`
cloudPlatform	string	The cloud provider where the location is hosted. Only applicable to `PUBLIC` locations. The element can hold these values `ALIBABA` `AMAZON_EC2` `AZURE` `DYNATRACE_CLOUD` `GOOGLE_CLOUD` `INTEROUTE` `OTHER` `UNDEFINED`
ips	string[]	The list of IP addresses assigned to the location. Only applicable to `PUBLIC` locations.
stage	string	The release stage of the location. The element can hold these values `BETA` `COMING_SOON` `DELETED` `GA`
status	string	The status of the location. The element can hold these values `DISABLED` `ENABLED` `HIDDEN`
geoLocationId	string	The Dynatrace GeoLocation ID of the location.

Response body JSON model

json
{
  "locations": [
    {
      "name": "Gdansk",
      "entityId": "SYNTHETIC_LOCATION-53F47ECB33907667",
      "geoLocationId": "GEOLOCATION-95196F3C9A4F4215",
      "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",
      "geoLocationId": "GEOLOCATION-95196F3C9A4F4215",
      "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

bash
curl -X GET \
  https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

plaintext
https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations

Response body

json
{
  "locations": [
    {
      "name": "Amazon US East (N. Virginia)",
      "entityId": "SYNTHETIC_LOCATION-0000000000000004",
      "type": "PUBLIC",
      "cloudPlatform": "AMAZON_EC2",
      "ips": [
        "79.50.224.74",
        "96.124.117.100"
      ],
      "stage": "GA",
      "status": "ENABLED",
      "capabilities": [
        "BROWSER"
      ],
      "geoLocationId": "GEOLOCATION-95196F3C9A4F4215"
    },
    {
      "name": "Gdańsk",
      "entityId": "SYNTHETIC_LOCATION-0000000000000064",
      "type": "PUBLIC",
      "cloudPlatform": "OTHER",
      "ips": [
        "120.157.221.247",
        "172.158.6.93",
        "197.136.70.30",
        "227.53.205.237",
        "131.123.197.12"
      ],
      "stage": "GA",
      "status": "ENABLED",
      "capabilities": [
        "BROWSER",
        "HTTP"
      ],
      "geoLocationId": "GEOLOCATION-0A41430434C388A9"
    },
    {
      "name": "Linz HTTP",
      "entityId": "SYNTHETIC_LOCATION-BB5EE23C1D48AFF5",
      "type": "PRIVATE",
      "status": "ENABLED",
      "geoLocationId": "GEOLOCATION-427705B3488A4C45"
    }
  ]
}

Response code

200