Try it free

ActiveGate auto-update configuration API - GET global

  • Reference
  • Published Mar 15, 2021

Gets the global auto-update configuration of Environment ActiveGates.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/activeGates/autoUpdate
GETEnvironment and Cluster ActiveGate (default port 9999)https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/activeGates/autoUpdate

Authentication

To execute this request, you need an access token with activeGates.read scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

The request doesn't provide any configurable parameters.

Response

Response codes

CodeTypeDescription
200ActiveGateGlobalAutoUpdateConfig

Success

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The ActiveGateGlobalAutoUpdateConfig object

Global configuration of ActiveGates auto-update.

ElementTypeDescription
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.

The element can hold these values
  • ENABLED
  • DISABLED
metadataConfigurationMetadata

Metadata useful for debugging

targetVersionstring

Version to update a ActiveGate to when automatic updates are enabled.

Supports relative versions latest, previous and older as well as specific version in <major>.<minor> format (for example 1.261).

Only applicable when the setting parameter is set to ENABLED.

updateWindowsUpdateWindowsConfig

Basic information about all configured update windows

The ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescription
clusterVersionstring

Dynatrace version.

configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

currentConfigurationVersionsstring[]

A sorted list of version numbers of the configuration.

The UpdateWindowsConfig object

Basic information about all configured update windows

ElementTypeDescription
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.

The UpdateWindow object

Basic information about one maintenance window

ElementTypeDescription
idstring

Identifier of maintenance window

namestring

The name of maintenance window

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

{
  "globalSetting": "ENABLED",
  "metadata": {
    "clusterVersion": "1.192.1",
    "configurationVersions": [
      4,
      2
    ],
    "currentConfigurationVersions": [
      "1.0.4",
      "1.23"
    ]
  },
  "targetVersion": "latest",
  "updateWindows": {
    "windows": [
      {
        "id": "vu9U3hXa3q0AAAABADdkeW5hdHJhY2Uuc2V0dGluZ3MuZGVwbG95bWVudC5tYW5h",
        "name": "Daily maintenance window"
      }
    ]
  }
}
{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}

Related topics

  • Dynatrace ActiveGate