• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • OneAgent updates

Settings API - OneAgent updates schema table

OneAgent updates (builtin:deployment.oneagent.updates)

Configure OneAgent update behavior. To learn more about the latest updates, visit OneAgent release notes. To configure RUM JavaScript update behaviour, visit RUM JavaScript updates.

Schema IDSchema groupsScope
builtin:deployment.oneagent.updates
  • group:updates
HOST - Host
HOST_GROUP - Host Group
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:deployment.oneagent.updates
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:deployment.oneagent.updates
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:deployment.oneagent.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

PropertyLabelTypeDescriptionRequired
updateModeUpdate modeenum-required
maintenanceWindowsMaintenance windowsset-required
targetVersionTarget versiontext-required
revisionRevisiontext-required

Request body objects

The maintenanceWindow object
PropertyLabelTypeDescriptionRequired
maintenanceWindowMaintenance windowsetting

Select a maintenance window for OneAgent updates

required