Update your company's maintenance window
Sets the default window for every site and CoreCluster of your company that has none of its own. Changes already queued for them move to the new window.
Body
The hour the window opens, from 0 to 23, UK time.
Returns
200 The window was saved. restamped counts the queued changes that moved.
Fields of the 200 answer
Fields
At least 1.
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 start hour set at this level. Null when the level has none of its own and inherits.
How many sites and CoreClusters the default reaches.
Fields
Sent after a change: how many queued changes moved to the new window.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | company_unavailable | Your company is unavailable. |
403 | scope_required | Use a token with the scope named in scope. |
403 | two_factor_required | Turn on two-factor on your account, then send again. |
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. |
429 | throttled | Too many tries. Wait a minute and try again. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl -X PUT https://manage.corefinity.com/api/company/maintenance-window \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"start_hour": 3
}'use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->put('https://manage.corefinity.com/api/company/maintenance-window', [
'start_hour' => 3,
]);
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/company/maintenance-window', {
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
'Content-Type': 'application/json',
},
body: JSON.stringify({
start_hour: 3,
}),
});
// 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.put(
"https://manage.corefinity.com/api/company/maintenance-window",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
json={
"start_hour": 3,
},
)
data = res.json() if res.content else None{
"company": {
"id": 1204,
"name": "Harbour & Finch"
},
"editable": true,
"effective": {
"end_hour": 7,
"label": "03:00–07:00 UK time",
"length_hours": 4,
"source": "company",
"source_label": "Company default",
"staff_locked": false,
"start_hour": 3,
"timezone": "Europe/London"
},
"inherited": {
"level": "platform",
"name": "Corefinity default",
"start_hour": 0
},
"own": {
"start_hour": 3
},
"reach": {
"clusters": 1,
"sites": 1
},
"restamped": 0
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"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
}