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

Get a CoreCluster's maintenance window

Answers the default window of the CoreCluster, where it comes from, and the sites that have a window of their own.

GET/api/coreclusters/{cluster}/maintenance-window

Path parameters

clusterintegerRequired

The id of a CoreCluster. Digits only. At least 1.

Returns

200 The window.

Fields of the 200 answer
clusterobjectRequired

A cluster by its id and name. A standalone CoreStack site reads CoreStack as the name.

Fields
idintegerRequired
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.

overridesobjectRequired

The sites of the CoreCluster that have a window of their own.

Fields
countintegerRequired
sitesarray of objectsRequired
Fields of each item
domainstringRequired
idintegerRequired

At least 1.

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.

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/coreclusters/1017/maintenance-window \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "cluster": {
    "id": 1017,
    "name": "Northwind UK 1"
  },
  "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
  },
  "overrides": {
    "count": 0,
    "sites": []
  },
  "own": null
}
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