Synthetic locations API - GET all locations

Lists all locations, public and private, and their parameters available for your environment.

The request produces an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/locations
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v1/synthetic/locations

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 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.

The cloudPlatform element can hold these values.
query optional
type string

Filters the resulting set of locations by a specific type.

The type element can hold these values.
query optional

Possible values

Possible values for the type element:

  • PUBLIC
  • PRIVATE

Possible values for the cloudPlatform element:

  • AWS
  • AZURE
  • ALIBABA
  • OTHER

Response format

The SyntheticLocations object

A list of synthetic locations.

Element Type Description
locations LocationCollectionElement[]

A list of synthetic locations.

The LocationCollectionElement object

A list of synthetic locations.

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 type element can hold these values.
cloudPlatform string

The cloud provider where the location is hosted.

Only applicable to PUBLIC locations.

The cloudPlatform element can hold these values.
ips string[]

The list of IP addresses assigned to the location.

Only applicable to PUBLIC locations.

stage string

Determines the location stage

The stage element can hold these values.
status string

Determines whether a location is enabled, disabled or hidden

The status element can hold these values.

Possible values

Possible values for the status element in the LocationCollectionElement object:

  • DISABLED
  • ENABLED
  • HIDDEN

Possible values for the stage element in the LocationCollectionElement object:

  • BETA
  • COMING_SOON
  • GA

Possible values for the cloudPlatform element in the LocationCollectionElement object:

  • ALIBABA
  • AMAZON_EC2
  • AZURE
  • DYNATRACE_CLOUD
  • GOOGLE_CLOUD
  • INTEROUTE
  • OTHER
  • PHYSICAL
  • UNDEFINED

Possible values for the type element in the LocationCollectionElement object:

  • CLUSTER
  • PRIVATE
  • PUBLIC

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