ActiveGate auto-update configuration API - PUT global

Edits the global auto-update configuration of Environment ActiveGates.

The request consumes an application/json payload.

PUTSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/autoUpdate
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/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

ParameterTypeDescriptionInRequired
bodyActiveGateGlobalAutoUpdateConfig

JSON body of the request, containing global auto update parameters.

bodyrequired

Request body objects

The ActiveGateGlobalAutoUpdateConfig object

Global configuration of ActiveGates auto-update.

ElementTypeDescriptionRequired
globalSettingstring

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 INHERITED setting.

  • ENABLED
  • DISABLED
required
metadataConfigurationMetadata

Metadata useful for debugging

optional

The ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescriptionRequired
clusterVersionstring

Dynatrace version.

optional
configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

optional
currentConfigurationVersionsstring[]

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

CodeTypeDescription
204-

Success. The global auto-update configuration have been updated. Response doesn't have a body.

400ErrorEnvelope

Failed. The input is invalid.

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

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.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/autoUpdate/validator
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/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

CodeTypeDescription
204-

Validated. The submitted configuration is valid. Response doesn't have a body.

400ErrorEnvelope

Failed. The input is invalid.

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.