Get a site's maintenance window
Answers the window in force for the site, where it comes from, its next occurrence and whether you can change it. An environment answers its website's window.
Path parameters
The id of a site row. A website's production site and each of its environments has its own id. Digits only. At least 1.
Returns
200 The window.
Fields of the 200 answer
Why the window cannot be changed. Sent only when editable is false.
window_scope_unavailableforbiddenwindow_lockedThe window in force, wherever it comes from.
Fields
The hour the window closes. 0 to 23.
The window in words, such as 00:00–04:00 UK time.
The level the window comes from. staff_lock is a window Corefinity has set, which cannot be changed here.
siteclusterstaff_lockcompanyplatformTrue when Corefinity has set the window.
The hour the window opens, in timezone. 0 to 23.
The window this level uses when it has none of its own.
Fields
websiteclustercompanyplatform0 to 23.
The next occurrence of the window.
The notice period while it runs: until is its end, or null before it has a date. Null once it has passed.
The start hour set at this level. Null when the level has none of its own and inherits.
Changes waiting for the window.
Fields
Whether you are told about them before they apply.
Sent after a change: how many queued changes moved to the new window.
A site by its id and domain.
Fields
A scheduled snapshot that falls inside the window, with its local time. Null when there is none.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | scope_required | Use a token with the scope named in scope. |
404 | feature_off | This feature is not on for your organisation yet. |
429 | rate_limited | Wait for the seconds in Retry-After. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl https://manage.corefinity.com/api/corestack/sites/1042/maintenance-window \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json"use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->get('https://manage.corefinity.com/api/corestack/sites/1042/maintenance-window');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/maintenance-window', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
},
});
// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);import os
import requests
res = requests.get(
"https://manage.corefinity.com/api/corestack/sites/1042/maintenance-window",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"editable": true,
"effective": {
"end_hour": 4,
"label": "00:00–04:00 UK time",
"length_hours": 4,
"source": "platform",
"source_label": "Corefinity default",
"staff_locked": false,
"start_hour": 0,
"timezone": "Europe/London"
},
"inherited": {
"level": "platform",
"name": "Corefinity default",
"start_hour": 0
},
"next": {
"ends_at": "2026-11-04T04:00:00Z",
"hours": 4,
"label": "00:00–04:00 UK time",
"last_start_at": "2026-11-04T03:30:00Z",
"local_date": "2026-11-04",
"starts_at": "2026-11-04T00:00:00Z"
},
"notice_period": {
"until": null
},
"own": null,
"pending": {
"count": 0,
"notice": false
},
"site": {
"domain": "harbourandfinch.example.com",
"id": 1042
},
"snapshot_overlap": null
}{
"message": "Unauthenticated."
}{
"code": "scope_required",
"message": "This access token does not have the destructive scope this needs. Use a token with the destructive scope.",
"reason": "scope_required",
"scope": "destructive"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}