• Home
  • Dynatrace API
  • Environment
  • Synthetic v1
  • Locations
  • GET all locations

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.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v1/synthetic/locations
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v1/synthetic/locations
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/locations

Authentication

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.

Parameters

ParameterTypeDescriptionInRequired
cloudPlatformstring

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
queryoptional
typestring

Filters the resulting set of locations by a specific type.

The element can hold these values
  • PUBLIC
  • PRIVATE
queryoptional

Response

Response codes

CodeTypeDescription
200SyntheticLocations

Success

Response body objects

The SyntheticLocations object

A list of synthetic locations.

ElementTypeDescription
locationsLocationCollectionElement[]

A list of synthetic locations.

The LocationCollectionElement object

A synthetic location.

ElementTypeDescription
namestring

The name of the location.

entityIdstring

The Dynatrace entity ID of the location.

typestring

The type of the location.

The element can hold these values
  • CLUSTER
  • PRIVATE
  • PUBLIC
cloudPlatformstring

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
ipsstring[]

The list of IP addresses assigned to the location.

Only applicable to PUBLIC locations.

stagestring

The release stage of the location.

The element can hold these values
  • BETA
  • COMING_SOON
  • DELETED
  • GA
statusstring

The status of the location.

The element can hold these values
  • DISABLED
  • ENABLED
  • HIDDEN

Response body JSON model

json
{ "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

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

Request URL

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

Response body

json
{ "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

Related topics
  • Synthetic Monitoring

    Learn about Synthetic Monitoring and how to create a single-URL browser monitor, a browser clickpath, or an HTTP monitor.