• Home
  • Dynatrace API
  • Environment
  • ActiveGates
  • ActiveGates auto-update configuration
  • PUT an ActiveGate

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.

PUTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/autoUpdate
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/{agId}/autoUpdate
Environment ActiveGatehttps://{your-activegate-domain}/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

ParameterTypeDescriptionInRequired
agIdstring

The ID of the required ActiveGate.

pathrequired
bodyActiveGateAutoUpdateConfig

JSON body of the request, containing auto update parameters.

bodyrequired

Request body objects

The ActiveGateAutoUpdateConfig object

Configuration of the ActiveGate auto-updates.

ElementTypeDescriptionRequired
settingstring

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.

The element can hold these values
  • DISABLED
  • ENABLED
  • INHERITED
required
effectiveSettingstring

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.

The element can hold these values
  • ENABLED
  • DISABLED
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.

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

Response

Response codes

CodeTypeDescription
204

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

400ErrorEnvelope

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.

POSTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/autoUpdate/validator
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/{agId}/autoUpdate/validator
Environment ActiveGatehttps://{your-activegate-domain}/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

CodeTypeDescription
204

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

400ErrorEnvelope

Failed. The input is invalid.

Related topics
  • Dynatrace ActiveGate

    Understand the basic concepts related to ActiveGate.