• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Maintenance windows for OneAgent updates

Settings API - Maintenance windows for OneAgent updates schema table

Maintenance windows for OneAgent updates (builtin:deployment.management.update-windows)

Define maintenance windows for how often and when to update your OneAgent instances. You will be able to apply these windows to OneAgents, Host Groups or your whole Environment in Automatic Update settings screens.

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

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
enabledOn/Offboolean-required
nameNametext-required
recurrenceRecurrenceenum-required
onceRecurrence-onceRecurrence-required
dailyRecurrence-dailyRecurrence-required
weeklyRecurrence-weeklyRecurrence-required
monthlyRecurrence-monthlyRecurrence-required

Request body objects

The onceWindow object
PropertyLabelTypeDescriptionRequired
startStartzoned_date_time-required
endEndzoned_date_time-required
The onceRecurrence object
PropertyLabelTypeDescriptionRequired
recurrenceRangeUpdate timeonceWindow-required
The updateTime object
PropertyLabelTypeDescriptionRequired
startTimeStart time (24-hour clock)text-required
timeZoneTime zoneenum-required
durationDuration (minutes)integer-required
The recurrenceRange object
PropertyLabelTypeDescriptionRequired
startStartzoned_date_time-required
endEndzoned_date_time-required
The selectedWeekDays object
PropertyLabelTypeDescriptionRequired
mondayMondayboolean-required
tuesdayTuesdayboolean-required
wednesdayWednesdayboolean-required
thursdayThursdayboolean-required
fridayFridayboolean-required
saturdaySaturdayboolean-required
sundaySundayboolean-required
The dailyRecurrence object
PropertyLabelTypeDescriptionRequired
everyEvery X daysinteger

Every X days:

  • 1 = every day,
  • 2 = every two days,
  • 3 = every three days,
  • etc.
required
updateTimeUpdate timeupdateTime-required
recurrenceRangeRecurrence rangerecurrenceRange-required
The weeklyRecurrence object
PropertyLabelTypeDescriptionRequired
selectedWeekDaysDay of the weekselectedWeekDays-required
everyEvery X weeksinteger

Every X weeks:

  • 1 = every week,
  • 2 = every two weeks,
  • 3 = every three weeks,
  • etc.
required
updateTimeUpdate timeupdateTime-required
recurrenceRangeRecurrence rangerecurrenceRange-required
The monthlyRecurrence object
PropertyLabelTypeDescriptionRequired
selectedMonthDayDay of the monthinteger-required
everyEvery X monthsinteger

Every X months:

  • 1 = every month,
  • 2 = every two months,
  • 3 = every three months,
  • etc.
required
updateTimeUpdate timeupdateTime-required
recurrenceRangeRecurrence rangerecurrenceRange-required