Settings API - Update windows for OneAgent updates schema table

  • Published Dec 05, 2023

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 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
GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:deployment.management.update-windows
GETEnvironment 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

PropertyTypeDescriptionRequired
On/Off
enabled		boolean-Required
Name
name		text-Required
Recurrence
recurrence		enum
The element has these enums
  • ONCE
  • DAILY
  • WEEKLY
  • MONTHLY
Required
onceRecurrenceonceRecurrence-Required
dailyRecurrencedailyRecurrence-Required
weeklyRecurrenceweeklyRecurrence-Required
monthlyRecurrencemonthlyRecurrence-Required
The onceRecurrence object
PropertyTypeDescriptionRequired
Update time
recurrenceRange		onceWindow-Required
The dailyRecurrence object
PropertyTypeDescriptionRequired
Every X days
every		integer

Every X days:

  • 1 = every day,
  • 2 = every two days,
  • 3 = every three days,
  • etc.
Required
Update time
updateTime		updateTime-Required
Recurrence range
recurrenceRange		recurrenceRange-Required
The weeklyRecurrence object
PropertyTypeDescriptionRequired
Day of the week
selectedWeekDays		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		updateTime-Required
Recurrence range
recurrenceRange		recurrenceRange-Required
The monthlyRecurrence object
PropertyTypeDescriptionRequired
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		updateTime-Required
Recurrence range
recurrenceRange		recurrenceRange-Required
The onceWindow object
PropertyTypeDescriptionRequired
Start
start		zoned_date_time-Required
End
end		zoned_date_time-Required
The updateTime object
PropertyTypeDescriptionRequired
Start time (24-hour clock)
startTime		text-Required
Time zone
timeZone		enum
The element has these enums
  • 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
PropertyTypeDescriptionRequired
Start
start		zoned_date_time-Required
End
end		zoned_date_time-Required
The selectedWeekDays object
PropertyTypeDescriptionRequired
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