ActiveGate auto-update configuration API - PUT an ActiveGate

Edits the auto-update configuration of the specified Environment ActiveGate.

The request consumes an application/json payload.

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

The ID of the required ActiveGate.

path
required
body

JSON body of the request, containing auto update parameters.

body
required

Request body objects

The ActiveGateAutoUpdateConfig object

Configuration of the ActiveGate auto-updates.

Element
Type
Description
Required
effectiveSetting
string

The actual state of the ActiveGate auto-update.

Applicable only if the setting parameter is set to INHERITED. In that case, the value is taken from the parent setting. Otherwise, it's just a duplicate of the setting value.

  • ENABLED
  • DISABLED
optional
setting
string

The state of the ActiveGate auto-update: enabled, disabled, or inherited.

If set to INHERITED, the setting is inherited from the global configuration set on the environment or Managed cluster level.

  • DISABLED
  • ENABLED
  • INHERITED
required

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.

{
"effectiveSetting": "ENABLED",
"setting": "INHERITED"
}

Response

Response codes

Code
Type
Description
204
-

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

400

Failed. The input is invalid.

4XX

Client side error.

5XX

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/{agId}/autoUpdate/validator
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/activeGates/{agId}/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 auto-update configuration is valid. Response doesn't have a body.

400

Failed. The input is invalid.

4XX

Client side error.

5XX

Server side error.