Preview your company's window change
Answers what setting start_hour, or clearing the default, would do across your company's sites. Nothing is saved.
Query parameters
The start hour to try, from 0 to 23. Send this or clear.
Send 1 to preview removing the window set at this level, instead of start_hour.
1Returns
200 The preview.
Fields of the 200 answer
The queued changes that would move, for the sites you can see.
Fields of each item
sitenightplatformrolloutAt least 1.
The window in force after the change.
Fields
0 to 23.
siteclusterstaff_lockcompanyplatform0 to 23.
Nothing queued is applied before this time, so a change of window never applies work at once.
How many queued changes would move, including those of sites you cannot see.
The next occurrence after the change.
The notice period while it runs: until is its end, or null before it has a date. Null once it has passed.
A scheduled snapshot that falls inside the window, with its local time. Null when there is none.
True when the window would have the same times as now.
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. |
422 | window_start_invalid | The start hour is not one. Choose an hour from 00 to 23. |
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/company/maintenance-window/preview \
-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/company/maintenance-window/preview');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/company/maintenance-window/preview', {
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/company/maintenance-window/preview",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"batches": [],
"effective_after": {
"end_hour": 7,
"label": "03:00–07:00 UK time",
"source": "company",
"source_label": "Company default",
"start_hour": 3
},
"hold_until": "2026-11-03T09:30:00Z",
"moved": 0,
"next_after": {
"ends_at": "2026-11-04T07:00:00Z",
"label": "Tonight 03:00–07:00 UK time",
"starts_at": "2026-11-04T03:00:00Z"
},
"notice_period": {
"until": null
},
"snapshot_overlap": null,
"unchanged": false
}{
"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": "window_start_invalid",
"message": "Choose a start hour from 00 to 23.",
"reason": "window_start_invalid"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}