Remote environments API - POST a remote environment configuration
Creates a new remote environment configuration.
Before creation, Dynatrace verifies the provided URI and token by trying to reach the environment using the token for authentication. If the attempt fails, no remote environment configuration is created.
The request consumes and produces an application/json payload.
| POST | Managed | https://{your-domain}/e/{your-environment-id}/api/config/v1/remoteEnvironments |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/remoteEnvironments | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/remoteEnvironments |
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
The body must not provide an ID. An ID is assigned automatically by Dynatrace.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| body | Remote | The JSON body of the request. Contains parameters of the new remote environment configuration. | body | optional |
Request body objects
The RemoteEnvironmentConfigDto object
| Element | Type | Description | Required |
|---|---|---|---|
| networkScope | string | The network scope of the remote environment:
Dynatrace SaaS can only use If not set, | optional |
| displayName | string | The display name of the remote environment. | required |
| id | string | The ID of the configuration. | optional |
| 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 | optional |
| uri | string | The URI of the remote environment. | required |
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",
"displayName": "string",
"id": "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. |
| 400 | ErrorEnvelope | 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, |
| name | string | - |
| id | string | - |
| uri | string | The display name of the remote environment. |
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.
| POST | Managed | https://{your-domain}/e/{your-environment-id}/api/config/v1/remoteEnvironments/validator |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/remoteEnvironments/validator | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/remoteEnvironments/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 | ErrorEnvelope | Failed. The input is invalid. |
Example
In this example, the request creates a new remote environment configuration, referring to the Pre-Production environment.
The API token is passed in the Authorization header.
Curl
curl -X POST \
https://mySampleEnv.live.dynatrace.com/api/config/v1/remoteEnvironments/ \
-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": "1234567890abcdefjhij",
"networkScope": "EXTERNAL"
}
'Request URL
https://mySampleEnv.live.dynatrace.com/api/config/v1/remoteEnvironments/Request body
{
"displayName": "Pre-Production",
"uri": "https://PreProd.live.dynatrace.com",
"token": "1234567890abcdefjhij",
"networkScope": "INTERNAL"
}
Response body
{
"id": "c89b9d9f-8c59-4c5b-b7ef-1a082d11e9ba",
"name": "Pre-Production",
"uri": "https://preProd.live.dynatrace.com",
"networkScope": "EXTERNAL"
}Response code
201