Remote environments API - DELETE a remote environment configuration

This API is deprecated. Use the Settings API instead. Look for the Remote environment (builtin:remote.environment) schema.

Deletes the specified remote environment configuration.

DELETESaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/remoteEnvironments/{id}
Environment ActiveGatehttps://{your-activegate-domain}:9999/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

Parameter
Type
Description
In
Required
id
string

The ID of the configuration to be deleted.

path
required

Response

Response codes

Code
Description
204

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

Example

In this example, the request deletes the Pre-Production remote environment created in the POST request example. The response code of 204 indicates that the deletion was successful.

The API token is passed in the Authorization header.

Curl

curl -X DELETE \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/remoteEnvironments/c89b9d9f-8c59-4c5b-b7ef-1a082d11e9ba \
  -H 'Authorization: Api-token abcdefghij1234567890'

Request URL

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

Response code

204