Skip to main content
PUT
Update a maintenance window

Authorizations

Authorization
string
header
required

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

Headers

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
windowId
string<uuid>
required

Body

application/json
title
string | null

New title; null preserves current

Maximum string length: 500
status
enum<string> | null

New status; null preserves current

Available options:
INVESTIGATING,
IDENTIFIED,
MONITORING,
RESOLVED
impact
enum<string> | null

New impact level; null preserves current

Available options:
NONE,
MINOR,
MAJOR,
CRITICAL
affectedComponents
object[] | null

Updated affected components; null preserves current

postmortemBody
string | null

Postmortem body in markdown; empty string clears

postmortemUrl
string | null

URL to an external postmortem document; empty string clears

Maximum string length: 2048
Pattern: ^$|^https?://.*
published
boolean | null

Whether the incident is published on the public page; null preserves current. true publishes (sets publishedAt); false unpublishes (clears publishedAt)

scheduledFor
string<date-time> | null

New maintenance window start; null preserves current. Only for scheduled incidents

scheduledUntil
string<date-time> | null

New maintenance window end; null preserves current. Only for scheduled incidents

autoResolve
boolean | null

Whether the window auto-completes at scheduledUntil; null preserves current

reminderLeadMinutes
integer<int32>[] | null

Maintenance only: minutes before the window to remind subscribers (5–20160 each, distinct); null preserves current, an empty list removes the reminders still to come

Maximum array length: 5

Maintenance only: minutes before the window to remind subscribers (5–20160 each, distinct); null preserves current, an empty list removes the reminders still to come

Required range: 5 <= x <= 20160
notifySubscribersOfPostmortem
boolean | null

Email the postmortem to subscribers (resolved incidents with a postmortem only). Sending the same text again is a no-op; changed text is sent again

audienceIds
string<uuid>[] | null

New audiences that see it; null preserves current, an empty list shows it to everyone

Maximum array length: 50

New audiences that see it; null preserves current, an empty list shows it to everyone

Response

OK

data
object
required