Skip to main content
POST
/
api
/
v1
/
maintenance-windows
Create a maintenance window
curl --request POST \
  --url https://api.devhelm.io/api/v1/maintenance-windows \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "startsAt": "2023-11-07T05:31:56Z",
  "endsAt": "2023-11-07T05:31:56Z",
  "monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "repeatRule": "<string>",
  "reason": "<string>",
  "suppressAlerts": true
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organizationId": 123,
    "startsAt": "2023-11-07T05:31:56Z",
    "endsAt": "2023-11-07T05:31:56Z",
    "suppressAlerts": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "repeatRule": "<string>",
    "reason": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.devhelm.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
startsAt
string<date-time>
required

Scheduled start of the maintenance window (ISO 8601)

​
endsAt
string<date-time>
required

Scheduled end of the maintenance window (ISO 8601)

​
monitorId
string<uuid> | null

Monitor to attach this maintenance window to; null for org-wide

​
repeatRule
string | null

Reserved: iCal RRULE for recurring windows (stored but not yet honored)

Maximum string length: 100
​
reason
string | null

Human-readable reason for the maintenance (max 500 chars)

Maximum string length: 500
​
suppressAlerts
boolean | null

Whether to suppress alerts during this window (default: true)

Response

Created

​
data
object
required

Scheduled maintenance window for a monitor