Supercheck LogoSupercheck
Monitors API

Edit a maintenance window

PATCH
/api/maintenance-windows/{id}

Edits apply to future occurrences; an active occurrence keeps its times.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Project-scoped CLI token (sck_live_* or sck_test_*) for documented API operations that accept bearer authentication. Interactive browser operations may require a session cookie. Trigger keys (sck_trigger_* / legacy job_*) are accepted only by job trigger endpoints.

Path Parameters

id*string
Formatuuid

Request Body

application/json
  1. body
title?string
description?string
scope?string
Value in"project""services""monitors"
targets?
recurrence?string
Value in"once""daily""weekly""monthly"
timezone?string

IANA time zone

localStartTime?string
Match^\d{2}:\d{2}$
durationMinutes?integer

Shorter than the time between occurrences

Range5 <= value <= 10080
startsOn?string
Formatdate
endsOn?string
Formatdate
weekdays?array<>

Weekly: 0 = Sunday

monthDay?integer

Monthly: 1-28, or -1 for the last day

Response Body

Updated

application/json
  1. response
success?boolean
window?
Example Request
curl -X PATCH 'https://app.supercheck.io/api/maintenance-windows/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "success": true,  "window": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "title": "string",    "description": "string",    "state": "scheduled",    "scope": "project",    "recurrence": "once",    "timezone": "string",    "localStartTime": "string",    "durationMinutes": 0,    "startsOn": "2019-08-24",    "endsOn": "2019-08-24",    "weekdays": [      0    ],    "monthDay": 0,    "occurrenceStartsAt": "2019-08-24T14:15:22Z",    "occurrenceEndsAt": "2019-08-24T14:15:22Z",    "targets": [      {        "type": "service",        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"      }    ],    "statusPageIncidentIds": [      "da6f58bf-0ef2-4571-a37b-e6207b408783"    ]  }}