Settings API - Update windows for OneAgent updates schema table

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

Define update 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 ID
Schema groups
Scope
builtin:deployment.management.update-windows
  • group:updates
environment
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

Property
Type
Description
Required
On/Off
enabled
boolean
-
required
Name
name
text
-
required
Recurrence
recurrence
enum
  • ONCE
  • DAILY
  • WEEKLY
  • MONTHLY
required
onceRecurrence
-
required
dailyRecurrence
-
required
weeklyRecurrence
-
required
monthlyRecurrence
-
required
The onceRecurrence object
Property
Type
Description
Required
Update time
recurrenceRange
-
required
The dailyRecurrence object
Property
Type
Description
Required
Every X days
every
integer

Every X days:

  • 1 = every day,
  • 2 = every two days,
  • 3 = every three days,
  • etc.
required
Update time
updateTime
-
required
Recurrence range
recurrenceRange
-
required
The weeklyRecurrence object
Property
Type
Description
Required
Day of the week
selectedWeekDays
-
required
Every X weeks
every
integer

Every X weeks:

  • 1 = every week,
  • 2 = every two weeks,
  • 3 = every three weeks,
  • etc.
required
Update time
updateTime
-
required
Recurrence range
recurrenceRange
-
required
The monthlyRecurrence object
Property
Type
Description
Required
Day of the month
selectedMonthDay
integer
-
required
Every X months
every
integer

Every X months:

  • 1 = every month,
  • 2 = every two months,
  • 3 = every three months,
  • etc.
required
Update time
updateTime
-
required
Recurrence range
recurrenceRange
-
required
The onceWindow object
Property
Type
Description
Required
Start
start
zoned_date_time
-
required
End
end
zoned_date_time
-
required
The updateTime object
Property
Type
Description
Required
Start time (24-hour clock)
startTime
text
-
required
Time zone
timeZone
enum
  • GMT-12:00
  • GMT-11:00
  • GMT-10:00
  • GMT-09:00
  • GMT-08:00
  • GMT-07:00
  • GMT-06:00
  • GMT-05:00
  • GMT-04:00
  • GMT-03:00
  • GMT-02:00
  • GMT-01:00
  • GMT+00:00
  • GMT+01:00
  • GMT+02:00
  • GMT+03:00
  • GMT+04:00
  • GMT+05:00
  • GMT+06:00
  • GMT+07:00
  • GMT+08:00
  • GMT+09:00
  • GMT+10:00
  • GMT+11:00
  • GMT+12:00
required
Duration (minutes)
duration
integer
-
required
The recurrenceRange object
Property
Type
Description
Required
Start
start
zoned_date_time
-
required
End
end
zoned_date_time
-
required
The selectedWeekDays object
Property
Type
Description
Required
Monday
monday
boolean
-
required
Tuesday
tuesday
boolean
-
required
Wednesday
wednesday
boolean
-
required
Thursday
thursday
boolean
-
required
Friday
friday
boolean
-
required
Saturday
saturday
boolean
-
required
Sunday
sunday
boolean
-
required