Remote environments API - GET a remote environment configuration

Gets the properties of the specified remote environment configuration.

The request produces an application/json payload.

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/config/v1/remoteEnvironments/{id}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/remoteEnvironments/{id}

Parameters

Parameter Type Description In Required
id string

The ID of the required configuration.

path required

Response format

The RemoteEnvironmentConfigDto object

Element Type Description
token string

The API token granting access to the remote environment.

The token must have the Fetch data from a remote environment (RestRequestForwarding) scope. You can create such a token only via Tokens API.

For security reasons, GET requests return this field as null.

networkScope string

The network scope of the remote environment:

  • EXTERNAL: The remote environment is located in an another network.
  • INTERNAL: The remote environment is located in the same network.
  • CLUSTER: The remote environment is located in the same cluster.

Dynatrace SaaS can only use EXTERNAL.

If not set, EXTERNAL is used.

uri string

The URI of the remote environment.

id string

The ID of the configuration.

displayName string

The display name of the remote environment.

Example

In this example, the request inquires about the properties of the Production North remote environment, which has the ID b597955c-4706-40f6-b188-212faba25e1f.

The API token is passed in the Authorization header.

Curl

curl -X GET \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/remoteEnvironments/b597955c-4706-40f6-b188-212faba25e1f \
    -H 'Accept: application/json; charset=utf-8' \
    -H 'Authorization: Api-token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/config/v1/remoteEnvironments/b597955c-4706-40f6-b188-212faba25e1f

Response body

{
  "id": "b597955c-4706-40f6-b188-212faba25e1f",
  "displayName": "Production North",
  "uri": "https://prodNorth.live.dynatrace.com",
  "token": null,
  "networkScope": "EXTERNAL"
}

Response code

200