Try it free

Settings API - ActiveGate updates schema table

  • Published Dec 05, 2023

ActiveGate updates (builtin:deployment.activegate.updates)

Configure ActiveGate update behavior. To learn more about the latest updates, visit ActiveGate release notes.

Schema IDSchema groupsScope
builtin:deployment.activegate.updates
  • group:updates
ENVIRONMENT_ACTIVE_GATE
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:deployment.activegate.updates
GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:deployment.activegate.updates
GETEnvironment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:deployment.activegate.updates

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

PropertyTypeDescriptionRequired
Target version
targetVersion		text-Required
Update mode
updateMode		enum
The element has these enums
  • AUTOMATIC
  • AUTOMATIC_DURING_UW
  • MANUAL
Required
Update windows
updateWindows		Set<updateWindow>-Required
The updateWindow object
PropertyTypeDescriptionRequired
Update window
updateWindow		setting

Select an update window for ActiveGate updates (<your-dynatrace-url>//ui/settings/builtin:deployment.management.update-windows)

Required