Create

Create maintenance window

Create a new planned maintenance window

post

/api/status-page/{statusPageId}/planned-maintenance/create

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)

notifyboolean

Notify subscribers when maintenance starts

notifyNowboolean

Send notification about schedule now

notifyOnEndboolean

Send notification when maintenance ends

componentsstring[]required

remindersobject[]

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.spike.sh/api/status-page/{statusPageId}/planned-maintenance/create' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text",
    "desc": "text",
    "startDate": "text",
    "endDate": "text",
    "startTime": "text",
    "endTime": "text",
    "notify": true,
    "notifyNow": true,
    "notifyOnEnd": true,
    "components": [
      "text"
    ],
    "reminders": [
      {
        "time": 1,
        "unit": "minutes"
      }
    ]
  }'

200

401

200

No body

Maintenance window created successfully