---
title: "Get a CoreCluster's maintenance window"
url: https://docs.corefinity.com/api/reference/site-settings/get-cluster-maintenance-window
type: endpoint
last_updated: 2026-11-13
feature: maintenance-windows
related:
  - https://docs.corefinity.com/guides/sites/site-settings/maintenance-window.md
---
# 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.

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

- Scope: `read`
- Rate limit: 60 a minute
- Try it in the console: on

## Path parameters

- `cluster` (integer, required): The id of a CoreCluster. Digits only.

## Request

### curl

```bash
curl https://manage.corefinity.com/api/coreclusters/1017/maintenance-window \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
```

### PHP

```php
use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->get('https://manage.corefinity.com/api/coreclusters/1017/maintenance-window');

$data = $response->json();
```

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/coreclusters/1017/maintenance-window', {
  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);
```

### Python

```python
import os
import requests

res = requests.get(
    "https://manage.corefinity.com/api/coreclusters/1017/maintenance-window",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

data = res.json() if res.content else None
```

## Responses

### 200 The window.

```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
}
```

### 401 No token, or a token that is not valid.

```json
{
  "message": "Unauthenticated."
}
```

### 403 The token lacks the scope this endpoint needs. `scope` names it.

```json
{
  "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"
}
```

### 404 The cluster does not exist or is not a CoreCluster of your company (both answer the same body; shared hosting has no window of its own at this level), or maintenance windows are not on for the API (`feature_off`).

```json
{
  "code": "feature_off",
  "message": "Not found.",
  "reason": "feature_off"
}
```

### 429 Too many requests (`rate_limited`). Wait for the number of seconds in `Retry-After`, which `retry_after_seconds` repeats.

```json
{
  "code": "rate_limited",
  "message": "Too many requests. Try again in 60 seconds.",
  "reason": "rate_limited",
  "retry_after_seconds": 60
}
```

## If it is refused

| Status | Reason | What to do |
|---|---|---|
| 401 |  | 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`. |

## The same task elsewhere

- Guide: [Maintenance window](https://docs.corefinity.com/guides/sites/site-settings/maintenance-window.md)
