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

Get your company's maintenance window

Answers your company's default window and how many sites and CoreClusters it reaches. The company is the one your token belongs to.

GET/api/company/maintenance-window

Returns

200 The window.

Fields of the 200 answer
companyobjectRequired
Fields
idintegerRequired

At least 1.

namestringRequired
edit_refusalstring

Why the window cannot be changed. Sent only when editable is false.

window_scope_unavailableforbiddenwindow_locked
editablebooleanRequired
effectiveobjectRequired

The window in force, wherever it comes from.

Fields
end_hourintegerRequired

The hour the window closes. 0 to 23.

labelstringRequired

The window in words, such as 00:00–04:00 UK time.

length_hoursintegerRequired
sourcestringRequired

The level the window comes from. staff_lock is a window Corefinity has set, which cannot be changed here.

siteclusterstaff_lockcompanyplatform
source_labelstringRequired
staff_lockedbooleanRequired

True when Corefinity has set the window.

start_hourintegerRequired

The hour the window opens, in timezone. 0 to 23.

timezonestringRequired
inheritedobjectRequired

The window this level uses when it has none of its own.

Fields
levelstringRequired
websiteclustercompanyplatform
namestring or nullRequired
start_hourintegerRequired

0 to 23.

ownobject or any or nullRequired

The start hour set at this level. Null when the level has none of its own and inherits.

reachobjectRequired

How many sites and CoreClusters the default reaches.

Fields
clustersintegerRequired
sitesintegerRequired
restampedinteger

Sent after a change: how many queued changes moved to the new window.

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.
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 \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "company": {
    "id": 1204,
    "name": "Harbour & Finch"
  },
  "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
  },
  "own": null,
  "reach": {
    "clusters": 1,
    "sites": 1
  }
}
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