CorefinityCorefinityDocs
Open the Control PanelControl Panel
Maintenance windows · 4 of 14

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.

GET/api/company/maintenance-window/preview

Query parameters

start_hourinteger

The start hour to try, from 0 to 23. Send this or clear.

clearstring

Send 1 to preview removing the window set at this level, instead of start_hour.

1

Returns

200 The preview.

Fields of the 200 answer
batchesarray of objectsRequired

The queued changes that would move, for the sites you can see.

Fields of each item
afterobject or any or nullRequired
beforeobject or any or nullRequired
domainstringRequired
environmentobject or any or nullRequired
policystringRequired
sitenightplatformrollout
site_idintegerRequired

At least 1.

effective_afterobjectRequired

The window in force after the change.

Fields
end_hourintegerRequired

0 to 23.

labelstringRequired
sourcestringRequired
siteclusterstaff_lockcompanyplatform
source_labelstringRequired
start_hourintegerRequired

0 to 23.

hold_untilstringRequired

Nothing queued is applied before this time, so a change of window never applies work at once.

movedintegerRequired

How many queued changes would move, including those of sites you cannot see.

next_afterobject or any or nullRequired

The next occurrence after the change.

notice_periodobject or any or nullRequired

The notice period while it runs: until is its end, or null before it has a date. Null once it has passed.

snapshot_overlapobject or any or nullRequired

A scheduled snapshot that falls inside the window, with its local time. Null when there is none.

unchangedbooleanRequired

True when the window would have the same times as now.

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403scope_requiredUse a token with the scope named in scope.
404feature_offThis feature is not on for your organisation yet.
422window_start_invalidThe start hour is not one. Choose an hour from 00 to 23.
429rate_limitedWait 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"
{
  "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
}
Try it
Held in this tab's memory only. Never stored or sent to us.

Use a token with only the read scope. How to make one

Was this helpful?
Open in ClaudeOpen in ChatGPT