Try it free

Settings API - Maintenance Windows schema table

  • Published Jun 15, 2026

Maintenance Windows (builtin:maintenance-windows)

Create and configure maintenance-windows

Schema IDSchema groupsScope
builtin:maintenance-windows-
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:maintenance-windows
GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:maintenance-windows
GETEnvironment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:maintenance-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
Name of the maintenance window
name		text-Required
Enabled
enabled		boolean-Required
Description
description		text-Optional
Schedule definition
schedule		ScheduleDefinition-Required
DQL Filter
filter		text-Required
Auto-delete after expiration
autoDelete		boolean

When enabled, this maintenance window configuration will be automatically deleted 30 days after the end of its last execution.

Required
The ScheduleDefinition object
PropertyTypeDescriptionRequired
Trigger
trigger		Trigger

Trigger definition.

Required
Time zone
timezone		text-Optional
Duration
duration		integer

Duration of the maintenance window in minutes.

Required
The Trigger object
PropertyTypeDescriptionRequired
Trigger Type
type		enum

Type of trigger.

The element has these enums
  • time
  • once
Required
Time trigger
recurring		TimeTrigger-Required
Once Trigger
once		OnceTrigger-Required
The TimeTrigger object
PropertyTypeDescriptionRequired
Time
time		local_time

Time for the trigger.

Required
Recurring start date
earliestStart		local_date

Earliest start date for when the first instance of this maintenance window should be created.

Optional
Recurring end date
until		local_date

Date after which instances of this recurring maintenance window should no longer be created.

Optional
Recurrence rule
rule		text

Reference to rule which specifies on which days instance of this maintenance window should be created.

Optional
The OnceTrigger object
PropertyTypeDescriptionRequired
Date
date		local_date_time

Date for the once trigger.

Required