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 | Label | Type | Description | Required |
|---|---|---|---|---|
| enabled | On/Off | boolean | - | required |
| name | Name | text | - | required |
| recurrence | Recurrence | enum | - | required |
| onceRecurrence | - | onceRecurrence | - | required |
| dailyRecurrence | - | dailyRecurrence | - | required |
| weeklyRecurrence | - | weeklyRecurrence | - | required |
| monthlyRecurrence | - | monthlyRecurrence | - | required |
Request body objects
The onceWindow object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| start | Start | zoned_date_time | - | required |
| end | End | zoned_date_time | - | required |
The onceRecurrence object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| recurrenceRange | Update time | onceWindow | - | required |
The updateTime object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| startTime | Start time (24-hour clock) | text | - | required |
| timeZone | Time zone | enum | - | required |
| duration | Duration (minutes) | integer | - | required |
The recurrenceRange object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| start | Start | zoned_date_time | - | required |
| end | End | zoned_date_time | - | required |
The selectedWeekDays object
| Property | Label | 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 |
The dailyRecurrence object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| every | Every X days | integer | Every X days:
| required |
| updateTime | Update time | updateTime | - | required |
| recurrenceRange | Recurrence range | recurrenceRange | - | required |
The weeklyRecurrence object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| selectedWeekDays | Day of the week | selectedWeekDays | - | required |
| every | Every X weeks | integer | Every X weeks:
| required |
| updateTime | Update time | updateTime | - | required |
| recurrenceRange | Recurrence range | recurrenceRange | - | required |
The monthlyRecurrence object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| selectedMonthDay | Day of the month | integer | - | required |
| every | Every X months | integer | Every X months:
| required |
| updateTime | Update time | updateTime | - | required |
| recurrenceRange | Recurrence range | recurrenceRange | - | required |