ActiveGate auto-update configuration API - PUT global
Edits the global auto-update configuration of Environment ActiveGates.
The request consumes an application/json payload.
| PUT | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/autoUpdate |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/autoUpdate | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/autoUpdate |
Authentication
To execute this request, you need an access token with activeGates.write scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| body | Active | JSON body of the request, containing global auto update parameters. | body | required |
Request body objects
The ActiveGateGlobalAutoUpdateConfig object
Global configuration of ActiveGates auto-update.
| Element | Type | Description | Required |
|---|---|---|---|
| globalSetting | string | The state of auto-updates for all ActiveGates connected to the environment or Managed cluster. This setting is inherited by all ActiveGates that have the | required |
| metadata | Configuration | Metadata useful for debugging | optional |
The ConfigurationMetadata object
Metadata useful for debugging
| Element | Type | Description | Required |
|---|---|---|---|
| clusterVersion | string | Dynatrace version. | optional |
| configurationVersions | integer[] | A sorted list of the version numbers of the configuration. | optional |
| currentConfigurationVersions | string[] | A sorted list of version numbers of the configuration. | optional |
Request body JSON model
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{
"globalSetting": "ENABLED",
"metadata": {
"clusterVersion": "1.192.1",
"configurationVersions": [
4,
2
],
"currentConfigurationVersions": [
"1.0.4",
"1.23"
]
}
}Response
Response codes
| Code | Type | Description |
|---|---|---|
| 204 | Success. The global auto-update configuration have been updated. Response doesn't have a body. | |
| 400 | ErrorEnvelope | Failed. The input is invalid. |
Validate payload
We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.
The request consumes an application/json payload.
| POST | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/autoUpdate/validator |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/autoUpdate/validator | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGates/autoUpdate/validator |
Authentication
To execute this request, you need an access token with activeGates.write scope.
To learn how to obtain and use it, see Tokens and authentication.
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 204 | Validated. The submitted configuration is valid. Response doesn't have a body. | |
| 400 | ErrorEnvelope | Failed. The input is invalid. |