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 |
|
Authentication
To execute this request, you need the Read configuration (ReadConfig
) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
id | string |
The ID of the required configuration. |
path | required |
Response
Response codes
Code | Description |
---|---|
200 | Success |
Response body
The RemoteEnvironmentConfigDto object
Element | Type | Description |
---|---|---|
networkScope | string | The network scope of the remote environment:
Dynatrace SaaS can only use If not set, |
id | string | The ID of the configuration. |
displayName | string | The display name of the remote environment. |
uri | string | The URI of the remote environment. |
token | string | The API token granting access to the remote environment. The token must have the Fetch data from a remote environment ( For security reasons, GET requests return this field as |
{
"networkScope": "EXTERNAL",
"id": "string",
"displayName": "string",
"uri": "string",
"token": "string"
}
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