Try it free

ActiveGate auto-update configuration API - PUT an ActiveGate

  • Reference
  • Published Mar 15, 2021

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
PUTEnvironment 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

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
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
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
targetVersionstring

The target version of the ActiveGate.

Specify the version in the <major>.<minor> format (for example 1.342) or latest, previous, or older.

Optional
updateWindowsUpdateWindowsConfig

Basic information about all configured update windows

Optional

The UpdateWindowsConfig object

Basic information about all configured update windows

ElementTypeDescriptionRequired
windowsUpdateWindow[]

List of update windows when the OneAgent update can start. If there is no value and update should be performed, the update will start at earliest convenience.

Required

The UpdateWindow object

Basic information about one maintenance window

ElementTypeDescriptionRequired
idstring

Identifier of maintenance window

Required
namestring

The name of maintenance window

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.

{
  "effectiveSetting": "ENABLED",
  "setting": "INHERITED",
  "targetVersion": "latest",
  "updateWindows": {
    "windows": [
      {
        "id": "vu9U3hXa3q0AAAABADdkeW5hdHJhY2Uuc2V0dGluZ3MuZGVwbG95bWVudC5tYW5h",
        "name": "Daily maintenance window"
      }
    ]
  }
}

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.

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code

constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

Response body JSON models

{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}

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
POSTEnvironment 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

CodeTypeDescription
204-

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

400ErrorEnvelope

Failed. The input is invalid.

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code

constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

Response body JSON models

{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}

Related topics

  • Dynatrace ActiveGate