Try it free

List ActiveGate groups for an extension

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026

List all ActiveGate groups available for an Extension 2.0 in Dynatrace with the Extensions API by extension name and version.

GETSaaShttps://{your-environment-id}.apps.dynatrace.com/platform/extensions/v2/extensions/{extension-name}/{extension-version}/active-gate-groups

Overview

You provide the extension name and extension version in the path. Dynatrace returns the ActiveGate groups available for that Extension 2.0 version.

Authentication

To execute this request, you need a platform token or OAuth access token with extensions:configurations: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
extension-versionstring

The version of the requested Extension 2.0

pathRequired

Response

Response codes

CodeTypeDescription
200ActiveGateGroupInfoList

Success.

4XXErrorEnvelope

Client error.

5XXErrorEnvelope

Server error.

Response body objects

The ActiveGateGroupInfoList object

ActiveGate groups metadata for extensions.

ElementTypeDescription
itemsActiveGateGroupInfo[]

Metadata for each ActiveGate group.

The ActiveGateGroupInfo object

Metadata for each ActiveGate group.

ElementTypeDescription
activeGatesActiveGateInfo[]

ActiveGates in group.

availableActiveGatesinteger

Number of ActiveGates in group available for extension.

groupNamestring

ActiveGate group name.

The ActiveGateInfo object

ActiveGates in group.

ElementTypeDescription
errorsstring[]

List of errors if Extension can't be run on the ActiveGate

idstring

ActiveGate ID.

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

{
"items": [
{
"activeGates": [
{
"errors": [
"string"
],
"id": "string"
}
],
"availableActiveGates": 1,
"groupName": "string"
}
]
}
{
"error": {
"code": 1,
"details": {
"constraintViolations": [
{
"location": "string",
"message": "string",
"parameterLocation": "HEADER",
"path": "string"
}
]
},
"message": "string"
}
}
Related tags
Platform APIDynatrace PlatformInfrastructure Observability