Status Page Maintenance

Create maintenance window

Create a new planned maintenance window

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

Request

Base URL
https://api.spike.sh
Auth
none declared. Required headers: x-api-key
TypeScript
https://skmtc.dev/spike/apis/spike-sh-api/docs/api/status-page/:statusPageId/planned-maintenance/create/post.ts
A function with typed inputs. Its response is checked against the schema.

statusPageIdstring required

Status Page ID

x-api-keystring required

API Key for authentication

titlestring required

Maintenance window title

descstring required

Maintenance description

startDatestring required

Start date (DD/MM/YYYY)

endDatestring required

End date (DD/MM/YYYY)

startTimestring required

Start time (HH:mm)

endTimestring required

End time (HH:mm)

notifyboolean

Notify subscribers when maintenance starts

componentsstring[] required

Array of component IDs

notifyNowboolean

Send notification about schedule now

notifyOnEndboolean

Send notification when maintenance ends

Maintenance window created successfully

No recorded changes to this operation across all 1 revision of this API.