Skip to main content
POST
Schedule a maintenance window

Authorizations

Authorization
string
header
required

API key (dh_live_...) or Auth0 JWT token

Headers

Idempotency-Key
string

Replays the stored response for 24h when the same key is sent again (1–255 visible ASCII)

X-DevHelm-Client
string

Calling surface and version, e.g. cli/1.4.0 or sdk-js/2.0.0

Path Parameters

id
string<uuid>
required

Body

application/json
title
string
required

Customer-facing maintenance title

Maximum string length: 500
impact
enum<string>
required

Impact level: NONE, MINOR, MAJOR, or CRITICAL

Available options:
NONE,
MINOR,
MAJOR,
CRITICAL
body
string
required

Initial update body in markdown

Minimum string length: 1
scheduledFor
string<date-time>
required

Maintenance start time

status
enum<string> | null

Initial status (default: INVESTIGATING)

Available options:
INVESTIGATING,
IDENTIFIED,
MONITORING,
RESOLVED
affectedComponents
object[] | null

Component IDs affected by this window

scheduledUntil
string<date-time> | null

Maintenance end time

autoResolve
boolean | null

Auto-resolve at scheduledUntil (default: false)

notifySubscribers
boolean | null

Whether to email confirmed subscribers about this window (default: true)

templateId
string<uuid> | null

Maintenance template the window is created from; its start and completion messages are posted automatically

reminderLeadMinutes
integer<int32>[] | null

Minutes before the window to email subscribers a reminder (5–20160 each, distinct). Default: the template's lead times, else 24 hours and 1 hour; an empty list sends none

Maximum array length: 5

Minutes before the window to email subscribers a reminder (5–20160 each, distinct). Default: the template's lead times, else 24 hours and 1 hour; an empty list sends none

Required range: 5 <= x <= 20160
audienceIds
string<uuid>[] | null

Audiences that see the window; empty for everyone who sees its components

Maximum array length: 50

Audiences that see the window; empty for everyone who sees its components

Response

Created

data
object
required