Try it free

Extensions 2.0 API - DELETE environment configuration

  • Reference
  • Published Jan 22, 2021

Deletes currently active environment configuration of the specified Extensions 2.0 extension.

The request produces an application/json payload.

DELETEManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/extensions/{extensionName}/environmentConfiguration
DELETEEnvironment and Cluster ActiveGate (default port 9999)https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/extensions/{extensionName}/environmentConfiguration

Authentication

Api-Token:

To execute this request, you need an access token with one of the following scopes:

  • extensionEnvironment.write
  • extensions.write

One of the following permissions is required for personal access tokens:

  • environment:roles:manage-settings
  • extensions:definitions:write

To learn how to obtain and use it, see Personal access tokens.

Platform Token / OAuth:

Required scope: extensions:definitions:write

To learn how to obtain and use it, see Platform tokens or OAuth clients.

Parameters

ParameterTypeDescriptionInRequired
extensionNamestring

The name of the requested extension 2.0.

pathRequired

Response

Response codes

CodeTypeDescription
200ExtensionEnvironmentConfigurationVersion

Success. Environment configuration deactivated.

404ErrorEnvelope

Failed. The requested resource doesn't exist.

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The ExtensionEnvironmentConfigurationVersion object

ElementTypeDescription
versionstring

Extension version

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code

constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

Response body JSON models

{
"version": "1.2.3"
}
{
"error": {
"code": 1,
"constraintViolations": [
{
"location": "string",
"message": "string",
"parameterLocation": "HEADER",
"path": "string"
}
],
"message": "string"
}
}

Related topics

  • Develop your own Extensions