Create

Create maintenance window

post

Create a new planned maintenance window

Path parameters

statusPageIdstringRequired

Status Page ID

Header parameters

x-api-keystringRequired

API Key for authentication

Body

titlestringRequired

Maintenance window title

descstringRequired

Maintenance description

startDatestringRequired

Start date (DD/MM/YYYY)

endDatestringRequired

End date (DD/MM/YYYY)

startTimestringRequired

Start time (HH:mm)

endTimestringRequired

End time (HH:mm)

notifybooleanOptional

Notify subscribers when maintenance starts

componentsstring[]Required

Array of component IDs

notifyNowbooleanOptional

Send notification about schedule now

notifyOnEndbooleanOptional

Send notification when maintenance ends

Responses

200

Maintenance window created successfully

401

Unauthorized

post

HTTPcURLJavaScriptPython

POST /api/status-page/{statusPageId}/planned-maintenance/create HTTP/1.1
Host: api.spike.sh
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 216

{
  "title": "text",
  "desc": "text",
  "startDate": "text",
  "endDate": "text",
  "startTime": "text",
  "endTime": "text",
  "notify": true,
  "components": [
    "text"
  ],
  "notifyNow": true,
  "notifyOnEnd": true,
  "reminders": [
    {
      "time": 1,
      "unit": "minutes"
    }
  ]
}

No content