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.
This request is an Early Adopter release and may be changed in non-compatible way.
| PUT | 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} | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/remoteEnvironments/{id} |
Authentication
To execute this request, you need an access token with Write configuration (WriteConfig) scope. To learn how to obtain and use it, see Tokens and authentication.
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| id | string | The ID of the configuration to be updated. If you set the ID in the body as well, it must match this ID. | path | required |
| body | Remote | The JSON body of the request. Contains updated parameters of the remote environment configuration. | body | optional |
Request body objects
The RemoteEnvironmentConfigDto object
| Element | Type | Description |
|---|---|---|
| networkScope | string | The network scope of the remote environment:
Dynatrace SaaS can only use If not set, Can be |
| id | string | The ID of the configuration. Can be |
| displayName | string | The display name 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 Can be |
| uri | string | The URI of the remote environment. |
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.
{
"networkScope": "EXTERNAL",
"id": "string",
"displayName": "string",
"token": "string",
"uri": "string"
}Response
Response codes
| Code | Type | Description |
|---|---|---|
| 201 | Remote | 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. |
| 400 | Error | Failed. The input is invalid. |
Response body objects
The RemoteEnvironmentConfigStub object
The short representation of a remote environment.
| Element | Type | Description |
|---|---|---|
| networkScope | string | The network scope of the remote environment:
Dynatrace SaaS can only use If not set, Can be |
| name | string | - Can be |
| id | string | - |
| uri | string | The display name of the remote environment. Can be |
Response body JSON model
{
"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.
This request is an Early Adopter release and may be changed in non-compatible way.
| POST | Managed | https://{your-domain}/e/{your-environment-id}/api/config/v1/remoteEnvironments/{id}/validator |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/remoteEnvironments/{id}/validator | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/remoteEnvironments/{id}/validator |
Authentication
To execute this request, you need an access token with Write configuration (WriteConfig) scope. To learn how to obtain and use it, see Tokens and authentication.
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 204 | - | Validated. The submitted configuration is valid. Response doesn't have a body |
| 400 | Error | 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
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
https://mySampleEnv.live.dynatrace.com/api/config/v1/remoteEnvironments/c89b9d9f-8c59-4c5b-b7ef-1a082d11e9baRequest body
{
"id": "c89b9d9f-8c59-4c5b-b7ef-1a082d11e9ba",
"displayName": "Pre-Production",
"uri": "https://PreProd.live.dynatrace.com",
"token": "0987654321jihgfedcba",
"networkScope": "INTERNAL"
}
Response code
204