List all ActiveGate groups available for an Extension 2.0 in Dynatrace with the Extensions API by extension name and version.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/extensions/v2/extensions/{extension-name}/{extension-version}/active-gate-groups |
You provide the extension name and extension version in the path. Dynatrace returns the ActiveGate groups available for that Extension 2.0 version.
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.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| extension-name | string | The name of the requested Extension 2.0. | path | Required |
| extension-version | string | The version of the requested Extension 2.0 | path | Required |
| Code | Type | Description |
|---|---|---|
| 200 | Active | Success. |
| 4XX | Error | Client error. |
| 5XX | Error | Server error. |
ActiveGateGroupInfoList objectActiveGate groups metadata for extensions.
| Element | Type | Description |
|---|---|---|
| items | Active | Metadata for each ActiveGate group. |
ActiveGateGroupInfo objectMetadata for each ActiveGate group.
| Element | Type | Description |
|---|---|---|
| activeGates | Active | ActiveGates in group. |
| availableActiveGates | integer | Number of ActiveGates in group available for extension. |
| groupName | string | ActiveGate group name. |
ActiveGateInfo objectActiveGates in group.
| Element | Type | Description |
|---|---|---|
| errors | string[] | List of errors if Extension can't be run on the ActiveGate |
| id | string | ActiveGate ID. |
ErrorEnvelope object| Element | Type | Description |
|---|---|---|
| error | Error | - |
Error object| Element | Type | Description |
|---|---|---|
| code | integer | The HTTP status code. |
| details | Error | The error details. |
| message | string | The error message. |
ErrorDetails objectThe error details.
| Element | Type | Description |
|---|---|---|
| constraintViolations | Constraint | A list of constraint violations. |
ConstraintViolation objectA list of constraint violations.
| Element | Type | Description |
|---|---|---|
| location | string | - |
| message | string | - |
| parameterLocation | string | -The element can hold these values
|
| path | string | - |
{"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"}}