• Home
  • Dynatrace API
  • Configuration
  • Remote environments
  • PUT a remote environment

Remote environments API - PUT a remote environment configuration

Updates the specified remote environment configuration. If a configuration with the specified ID doesn't exist, a new one is created.

The request consumes and produces an application/json payload.

PUTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/remoteEnvironments/{id}
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/remoteEnvironments/{id}
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/remoteEnvironments/{id}

Authentication

To execute this request, you need an access token with WriteConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
idstring

The ID of the configuration to be updated.

If you set the ID in the body as well, it must match this ID.

pathrequired
bodyRemoteEnvironmentConfigDto

The JSON body of the request. Contains updated parameters of the remote environment configuration.

bodyoptional

Request body objects

The RemoteEnvironmentConfigDto object

ElementTypeDescriptionRequired
networkScopestring

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.

The element can hold these values
  • CLUSTER
  • EXTERNAL
  • INTERNAL
optional
displayNamestring

The display name of the remote environment.

required
idstring

The ID of the configuration.

optional
uristring

The URI of the remote environment.

required
tokenstring

The API token granting access to the remote environment.

The token must have the Fetch data from a remote environment (RestRequestForwarding) scope.

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

optional

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

json
{
  "networkScope": "EXTERNAL",
  "displayName": "string",
  "id": "string",
  "uri": "string",
  "token": "string"
}

Response

Response codes

CodeTypeDescription
201RemoteEnvironmentConfigStub

Success. A new remote environment configuration has been created. The response contains the ID of the new configuration.

204

Success. The configuration has been updated. The response doesn't have a body.

400ErrorEnvelope

Failed. The input is invalid.

Response body objects

The RemoteEnvironmentConfigStub object

The short representation of a remote environment.

ElementTypeDescription
networkScopestring

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.

The element can hold these values
  • CLUSTER
  • EXTERNAL
  • INTERNAL
namestring-
idstring-
uristring

The display name of the remote environment.

Response body JSON model

json
{
  "networkScope": "CLUSTER",
  "name": "string",
  "id": "string",
  "uri": "string"
}

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.

POSTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/remoteEnvironments/{id}/validator
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/remoteEnvironments/{id}/validator
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/remoteEnvironments/{id}/validator

Authentication

To execute this request, you need an access token with WriteConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

CodeTypeDescription
204

Validated. The submitted configuration is valid. Response doesn't have a body

400ErrorEnvelope

Failed. The input is invalid.

Example

In this example, the request updated the API token of the Pre-Production remote environment created in the POST request example.

The API token is passed in the Authorization header.

Curl

bash
curl -X PUT \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/remoteEnvironments/c89b9d9f-8c59-4c5b-b7ef-1a082d11e9ba \
  -H 'Accept: application/json' \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \
  -d '{
  "displayName": "Pre-Production",
  "uri": "https://preProd.live.dynatrace.com",
  "token": "0987654321jihgfedcba",
  "networkScope": "EXTERNAL"
}
'

Request URL

plaintext
https://mySampleEnv.live.dynatrace.com/api/config/v1/remoteEnvironments/c89b9d9f-8c59-4c5b-b7ef-1a082d11e9ba

Request body

json
{
  "id": "c89b9d9f-8c59-4c5b-b7ef-1a082d11e9ba",
  "displayName": "Pre-Production",
  "uri": "https://PreProd.live.dynatrace.com",
  "token": "0987654321jihgfedcba",
  "networkScope": "INTERNAL"
}

Response code

204