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 ID | Schema groups | Scope |
---|---|---|
builtin:deployment.management.update-windows |
| environment |
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:deployment.management.update-windows |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:deployment.management.update-windows | |
Environment ActiveGate | https://{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/Offenabled | boolean | - | required |
Namename | text | - | required |
Recurrencerecurrence | enum |
| required |
onceRecurrence | onceRecurrence | - | required |
dailyRecurrence | dailyRecurrence | - | required |
weeklyRecurrence | weeklyRecurrence | - | required |
monthlyRecurrence | monthlyRecurrence | - | required |
The onceRecurrence
object
Property | Type | Description | Required |
---|---|---|---|
Update timerecurrenceRange | onceWindow | - | required |
The dailyRecurrence
object
Property | Type | Description | Required |
---|---|---|---|
Every X daysevery | integer | Every X days:
| required |
Update timeupdateTime | updateTime | - | required |
Recurrence rangerecurrenceRange | recurrenceRange | - | required |
The weeklyRecurrence
object
Property | Type | Description | Required |
---|---|---|---|
Day of the weekselectedWeekDays | selectedWeekDays | - | required |
Every X weeksevery | integer | Every X weeks:
| required |
Update timeupdateTime | updateTime | - | required |
Recurrence rangerecurrenceRange | recurrenceRange | - | required |
The monthlyRecurrence
object
Property | Type | Description | Required |
---|---|---|---|
Day of the monthselectedMonthDay | integer | - | required |
Every X monthsevery | integer | Every X months:
| required |
Update timeupdateTime | updateTime | - | required |
Recurrence rangerecurrenceRange | recurrenceRange | - | required |
The onceWindow
object
Property | Type | Description | Required |
---|---|---|---|
Startstart | zoned_date_time | - | required |
Endend | zoned_date_time | - | required |
The updateTime
object
Property | Type | Description | Required |
---|---|---|---|
Start time (24-hour clock)startTime | text | - | required |
Time zonetimeZone | enum |
| required |
Duration (minutes)duration | integer | - | required |
The recurrenceRange
object
Property | Type | Description | Required |
---|---|---|---|
Startstart | zoned_date_time | - | required |
Endend | zoned_date_time | - | required |
The selectedWeekDays
object
Property | Type | Description | Required |
---|---|---|---|
Mondaymonday | boolean | - | required |
Tuesdaytuesday | boolean | - | required |
Wednesdaywednesday | boolean | - | required |
Thursdaythursday | boolean | - | required |
Fridayfriday | boolean | - | required |
Saturdaysaturday | boolean | - | required |
Sundaysunday | boolean | - | required |