List upcoming maintenance windows
Answers the next seven days of windows with what is queued for each: for one site (site), for the sites of one CoreCluster (cluster), or for every site you can see, up to 200.
GET/ api/ maintenance-windows/ upcoming
Query parameters
siteinteger
The id of one site row. At least 1.
clusterinteger
The id of one CoreCluster. Read only when site is not sent. At least 1.
Returns
200 The days that have a window, soonest first.
Fields of the 200 answer
daysarray of objectsRequired
Fields of each item
local_datestringRequired
slotsarray of objectsRequired
Fields of each item
domainstringRequired
ends_atstringRequired
Format: date-time.
environmentobject or any or nullRequired
labelstringRequired
pendingarray of objectsRequired
What is queued for this occurrence.
Fields of each item
kind_labelstringRequired
ownbooleanRequired
True for a change you made yourself.
site_idintegerRequired
At least 1.
starts_atstringRequired
Format: date-time.
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. |
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/maintenance-windows/upcoming \
-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/maintenance-windows/upcoming');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/maintenance-windows/upcoming', {
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/maintenance-windows/upcoming",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"days": [
{
"local_date": "2026-11-04",
"slots": [
{
"domain": "harbourandfinch.example.com",
"ends_at": "2026-11-04T04:00:00Z",
"environment": null,
"label": "00:00–04:00 UK time",
"pending": [],
"site_id": 1042,
"starts_at": "2026-11-04T00:00:00Z"
}
]
}
]
}{
"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": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}Try it
Was this helpful?