ActiveGates auto-update configuration API - PUT an ActiveGate

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

The request consumes an application/json payload.

PUT
  • Managed https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/autoUpdate
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/{agId}/autoUpdate

Authentication

To execute this request, you need the Write ActiveGates (activeGates.write) permission assigned to your API token. 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 ActiveGateAutoUpdateConfig

JSON body of the request, containing auto update parameters.

body optional

Body format

The ActiveGateAutoUpdateConfig object

Configuration of the ActiveGate auto-updates.

Element Type Description Required
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.

required

Response

Response codes

Code Description
204

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

400

Failed. The input is invalid.

Response body

A successful request doesn't return any content.

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
  • Managed https://{your-domain}/e/{your-environment-id}/api/v2/activeGates/{agId}/autoUpdate/validator
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v2/activeGates/{agId}/autoUpdate/validator

Authentication

To execute this request, you need the Write ActiveGates (activeGates.write) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

Code Description
204

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

400

Failed. The input is invalid.

Response body

A successful request doesn't return any content.