Try it free

Get the active environment configuration for an extension

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026

Retrieve the active environment configuration version for an Extension 2.0 in Dynatrace with the Extensions API by extension name.

GETSaaShttps://{your-environment-id}.apps.dynatrace.com/platform/extensions/v2/extensions/{extension-name}/environment-configuration

Overview

You provide the extension-name path parameter to identify the Extension 2.0, and you can use add-fields to include additional response fields. Dynatrace returns the active environment configuration version for that extension.

Authentication

To execute this request, you need a platform token or OAuth access token with extensions:definitions:read scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
extension-namestring

The name of the requested Extension 2.0.

pathRequired
add-fieldsstring

Comma separated list of additional fields to include in the response. Available fields:

  • assets - includes assets of the Extension 2.0 in the environment.
  • status - includes installation status of assets of the Extension 2.0 in the environment.
  • errors - includes installation errors of assets of the Extension 2.0 in the environment.
queryOptional

Response

Response codes

CodeTypeDescription
200EnvironmentConfiguration

Success.

4XXErrorEnvelope

Client error.

5XXErrorEnvelope

Server error.

Response body objects

The EnvironmentConfiguration object

List of assets imported with the active extension environment configuration.

ElementTypeDescription
assetsAssetInfo[]

The list of the imported assets.

errorsstring[]

List of errors during asset import

statusstring

The status of the assets list.

The element can hold these values
  • PENDING
  • UP_TO_DATE
versionstring

Version of the active extension environment configuration.

The AssetInfo object

Metadata for an extension asset.

ElementTypeDescription
assetSchemaDetailsAssetSchemaDetails

Settings schema details for asset

displayNamestring

User-friendly name of the asset.

idstring

ID of the asset. Identifies the asset in REST API and/or UI (where applicable).

typestring

The type of the asset.

The element can hold these values
  • ALERT
  • ALERT_TEMPLATE
  • AWS_SERVICE
  • CUSTOM_CARDS
  • DASHBOARD
  • DECLARATIVE_PROCESSES
  • DOCUMENT_DASHBOARD
  • DOCUMENT_SCREEN
  • DQL_LOG_METRIC
  • DQL_LOG_PROCESSING_RULE
  • GENERIC_RELATIONSHIP
  • GENERIC_TYPE
  • LIST_SCREEN_FILTERS
  • LIST_SCREEN_INJECTIONS
  • LIST_SCREEN_LAYOUT
  • LOG_EVENT
  • LOG_METRIC
  • LOG_PROCESSING_RULE
  • LQL_LOG_METRIC
  • LQL_LOG_PROCESSING_RULE
  • METRIC_METADATA
  • METRIC_QUERY
  • OPEN_PIPELINE
  • PROCESS_GROUPING_RULES
  • SCREEN_ACTIONS
  • SCREEN_CHART_GROUPS
  • SCREEN_DQL_TABLE
  • SCREEN_ENTITIES_LISTS
  • SCREEN_EVENTS_CARDS
  • SCREEN_FILTERS
  • SCREEN_HEALTH_CARDS
  • SCREEN_INJECTIONS
  • SCREEN_LAYOUT
  • SCREEN_LOGS_CARDS
  • SCREEN_MESSAGE_CARDS
  • SCREEN_METRIC_TABLES
  • SCREEN_PROBLEMS
  • SCREEN_PROPERTIES

The AssetSchemaDetails object

Settings schema details for asset

ElementTypeDescription
keystring

Asset key

schemaIdstring

Asset schema id

scopestring

Asset configuration scope

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code.

detailsErrorDetails

The error details.

messagestring

The error message.

The ErrorDetails object

The error details.

ElementTypeDescription
constraintViolationsConstraintViolation[]

A list of constraint violations.

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

{
"assets": [
{
"assetSchemaDetails": {
"key": "string",
"schemaId": "string",
"scope": "string"
},
"displayName": "string",
"id": "string",
"type": "ALERT"
}
],
"errors": [
"string"
],
"status": "PENDING",
"version": "1.2.3"
}
{
"error": {
"code": 1,
"details": {
"constraintViolations": [
{
"location": "string",
"message": "string",
"parameterLocation": "HEADER",
"path": "string"
}
]
},
"message": "string"
}
}
Related tags
Platform APIDynatrace PlatformInfrastructure Observability