ActiveGate auto-update configuration API - PUT global

Reference
Published Mar 15, 2021

Edits the global auto-update configuration of Environment ActiveGates.

The request consumes an application/json payload.


PUT	ManagedDynatrace for Government	`https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/autoUpdate`
PUT	Environment 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.write scope.

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

Parameters

Parameter	Type	Description	In	Required
body	ActiveGateGlobalAutoUpdateConfig	JSON body of the request, containing global auto update parameters.	body	Required

Request body objects

The `ActiveGateGlobalAutoUpdateConfig` object

Global configuration of ActiveGates auto-update.

Element	Type	Description	Required
globalSetting	string	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`	Required
metadata	ConfigurationMetadata	Metadata useful for debugging	Optional
targetVersion	string	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`.	Optional
updateWindows	UpdateWindowsConfig	Basic information about all configured update windows	Optional

The `ConfigurationMetadata` object

Metadata useful for debugging

Element	Type	Description	Required
clusterVersion	string	Dynatrace version.	Optional
configurationVersions	integer[]	A sorted list of the version numbers of the configuration.	Optional
currentConfigurationVersions	string[]	A sorted list of version numbers of the configuration.	Optional

The `UpdateWindowsConfig` object

Basic information about all configured update windows

Element	Type	Description	Required
windows	UpdateWindow[]	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

Element	Type	Description	Required
id	string	Identifier of maintenance window	Required
name	string	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.

{
  "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"
      }
    ]
  }
}

Response

Response codes

Code	Type	Description
204	-	Success. The global auto-update configuration have been updated. Response doesn't have a body.
400	ErrorEnvelope	Failed. The input is invalid.
4XX	ErrorEnvelope	Client side error.
5XX	ErrorEnvelope	Server side error.

Response body objects

The `ErrorEnvelope` object

Element	Type	Description
error	Error	-

The `Error` object

Element	Type	Description
code	integer	The HTTP status code
constraintViolations	ConstraintViolation[]	A list of constraint violations
message	string	The error message

The `ConstraintViolation` object

A list of constraint violations

Element	Type	Description
location	string	-
message	string	-
parameterLocation	string	- The element can hold these values `HEADER` `PATH` `PAYLOAD_BODY` `QUERY`
path	string	-

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.


POST	ManagedDynatrace for Government	`https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/autoUpdate/validator`
POST	Environment and Cluster ActiveGate (default port 9999)	`https://{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

Code	Type	Description
204	-	Validated. The submitted configuration is valid. Response doesn't have a body.
400	ErrorEnvelope	Failed. The input is invalid.
4XX	ErrorEnvelope	Client side error.
5XX	ErrorEnvelope	Server side error.

Response body objects

The `ErrorEnvelope` object

Element	Type	Description
error	Error	-

The `Error` object

Element	Type	Description
code	integer	The HTTP status code
constraintViolations	ConstraintViolation[]	A list of constraint violations
message	string	The error message

The `ConstraintViolation` object

A list of constraint violations

Element	Type	Description
location	string	-
message	string	-
parameterLocation	string	- The element can hold these values `HEADER` `PATH` `PAYLOAD_BODY` `QUERY`
path	string	-

Response body JSON models

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

Dynatrace ActiveGate

ActiveGate auto-update configuration API - PUT global

Reference
Published Mar 15, 2021

Edits the global auto-update configuration of Environment ActiveGates.

The request consumes an application/json payload.


PUT	ManagedDynatrace for Government	`https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/autoUpdate`
PUT	Environment 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.write scope.

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

Parameters

Parameter	Type	Description	In	Required
body	ActiveGateGlobalAutoUpdateConfig	JSON body of the request, containing global auto update parameters.	body	Required

Request body objects

The `ActiveGateGlobalAutoUpdateConfig` object

Global configuration of ActiveGates auto-update.

Element	Type	Description	Required
globalSetting	string	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`	Required
metadata	ConfigurationMetadata	Metadata useful for debugging	Optional
targetVersion	string	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`.	Optional
updateWindows	UpdateWindowsConfig	Basic information about all configured update windows	Optional

The `ConfigurationMetadata` object

Metadata useful for debugging

Element	Type	Description	Required
clusterVersion	string	Dynatrace version.	Optional
configurationVersions	integer[]	A sorted list of the version numbers of the configuration.	Optional
currentConfigurationVersions	string[]	A sorted list of version numbers of the configuration.	Optional

The `UpdateWindowsConfig` object

Basic information about all configured update windows

Element	Type	Description	Required
windows	UpdateWindow[]	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

Element	Type	Description	Required
id	string	Identifier of maintenance window	Required
name	string	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.

{
  "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"
      }
    ]
  }
}

Response

Response codes

Code	Type	Description
204	-	Success. The global auto-update configuration have been updated. Response doesn't have a body.
400	ErrorEnvelope	Failed. The input is invalid.
4XX	ErrorEnvelope	Client side error.
5XX	ErrorEnvelope	Server side error.

Response body objects

The `ErrorEnvelope` object

Element	Type	Description
error	Error	-

The `Error` object

Element	Type	Description
code	integer	The HTTP status code
constraintViolations	ConstraintViolation[]	A list of constraint violations
message	string	The error message

The `ConstraintViolation` object

A list of constraint violations

Element	Type	Description
location	string	-
message	string	-
parameterLocation	string	- The element can hold these values `HEADER` `PATH` `PAYLOAD_BODY` `QUERY`
path	string	-

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.


POST	ManagedDynatrace for Government	`https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/autoUpdate/validator`
POST	Environment and Cluster ActiveGate (default port 9999)	`https://{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

Code	Type	Description
204	-	Validated. The submitted configuration is valid. Response doesn't have a body.
400	ErrorEnvelope	Failed. The input is invalid.
4XX	ErrorEnvelope	Client side error.
5XX	ErrorEnvelope	Server side error.

Response body objects

The `ErrorEnvelope` object

Element	Type	Description
error	Error	-

The `Error` object

Element	Type	Description
code	integer	The HTTP status code
constraintViolations	ConstraintViolation[]	A list of constraint violations
message	string	The error message

The `ConstraintViolation` object

A list of constraint violations

Element	Type	Description
location	string	-
message	string	-
parameterLocation	string	- The element can hold these values `HEADER` `PATH` `PAYLOAD_BODY` `QUERY`
path	string	-

Response body JSON models

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

Dynatrace ActiveGate

ActiveGate auto-update configuration API - PUT global

Authentication

Parameters

Request body objects

The ActiveGateGlobalAutoUpdateConfig object

The ConfigurationMetadata object

The UpdateWindowsConfig object

The UpdateWindow object

Request body JSON model

Response

Response codes

Response body objects

The ErrorEnvelope object

The Error object

The ConstraintViolation object

Response body JSON models

Validate payload

Authentication

Response

Response codes

Response body objects

The ErrorEnvelope object

The Error object

The ConstraintViolation object

Response body JSON models

Related topics

ActiveGate auto-update configuration API - PUT global

Authentication

Parameters

Request body objects

The ActiveGateGlobalAutoUpdateConfig object

The ConfigurationMetadata object

The UpdateWindowsConfig object

The UpdateWindow object

Request body JSON model

Response

Response codes

Response body objects

The ErrorEnvelope object

The Error object

The ConstraintViolation object

Response body JSON models

Validate payload

Authentication

Response

Response codes

Response body objects

The ErrorEnvelope object

The Error object

The ConstraintViolation object

Response body JSON models

Related topics

The `ActiveGateGlobalAutoUpdateConfig` object

The `ConfigurationMetadata` object

The `UpdateWindowsConfig` object

The `UpdateWindow` object

The `ErrorEnvelope` object

The `Error` object

The `ConstraintViolation` object

The `ErrorEnvelope` object

The `Error` object

The `ConstraintViolation` object

The `ActiveGateGlobalAutoUpdateConfig` object

The `ConfigurationMetadata` object

The `UpdateWindowsConfig` object

The `UpdateWindow` object

The `ErrorEnvelope` object

The `Error` object

The `ConstraintViolation` object

The `ErrorEnvelope` object

The `Error` object

The `ConstraintViolation` object