---
title: "Update maintenance mode"
url: https://docs.corefinity.com/api/reference/site-settings/update-site-maintenance-mode
type: endpoint
last_updated: 2026-11-13
feature: maintenance-mode
related:
  - https://docs.corefinity.com/guides/sites/create-and-manage/maintenance-mode.md
  - https://docs.corefinity.com/mcp/tools/corestack_maintenance_mode_set.md
---
# Update maintenance mode

Switches the site's maintenance mode on or off and checks the site afterwards. While it is on, visitors get the maintenance page; Corefinity support still sees the site (`bypass_corefinity` counts its addresses, which are not listed). The answer is the state the site was checked in and the command that switched it.

```http
POST /api/corestack/sites/{site}/maintenance
```

- Scope: `write`
- Two-factor: required on your account (all)
- Rate limit: 10 a minute
- Try it in the console: off. It has not been cleared for the console. Copy the request and run it yourself when you are sure.

## Path parameters

- `site` (integer, required): The id of a site row. A website's production site and each of its environments has its own id. Digits only.

## Body

- `enabled` (boolean, required): True switches maintenance mode on, false off.

## Request

### curl

```bash
curl -X POST https://manage.corefinity.com/api/corestack/sites/1042/maintenance \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true
  }'
```

### PHP

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

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->post('https://manage.corefinity.com/api/corestack/sites/1042/maintenance', [
        'enabled' => true,
    ]);

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

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/maintenance', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    enabled: true,
  }),
});

// 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.post(
    "https://manage.corefinity.com/api/corestack/sites/1042/maintenance",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
    json={
        "enabled": True,
    },
)

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

## Responses

### 200 The switch ran. `command.status` is `succeeded`, or `failed` with the reason in `command.error`. When the site was already in the state you asked for, nothing is switched or checked, and `command.result` has `host_checked` and `http_code` null.

```json
{
  "command": {
    "blocked_until_verified": false,
    "duration_ms": 212,
    "error": null,
    "exit_code": 0,
    "finished_at": "2026-11-06T09:21:07Z",
    "id": 905,
    "input": {
      "enabled": true
    },
    "kind": "maintenance",
    "label": "Maintenance mode",
    "operation_id": null,
    "output_excerpt": null,
    "queued_at": "2026-11-06T09:21:07Z",
    "requested_by": {
      "id": 2041,
      "name": "Eleanor Finch"
    },
    "result": {
      "enabled": true,
      "host_checked": null,
      "http_code": null
    },
    "site": {
      "domain": "harbourandfinch.example.com",
      "id": 1042
    },
    "started_at": "2026-11-06T09:21:07Z",
    "status": "succeeded",
    "status_label": "Done"
  },
  "maintenance": {
    "by": {
      "id": 2041,
      "name": "Eleanor Finch"
    },
    "bypass_corefinity": 1,
    "bypass_ips": [],
    "command": {
      "blocked_until_verified": false,
      "finished_at": "2026-11-06T09:21:07Z",
      "id": 905,
      "kind": "maintenance",
      "label": "Maintenance mode",
      "status": "succeeded",
      "status_label": "Done"
    },
    "enabled": true,
    "page": "default",
    "retry_after_seconds": 300,
    "since": "2026-11-06T09:16:41Z"
  }
}
```

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

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

### 403 The token lacks the scope (`scope_required`, with the `scope` to use), your company requires two-factor authentication and you have not set it up, or your account has no company that can use Managed Clusters, for example because the company was closed (`company_unavailable` or `company_not_enabled`, whichever the route checks first). For Managed Clusters routes; any other route uses `ForbiddenScopeOrTwoFactor`.

```json
{
  "code": "company_unavailable",
  "message": "Your company is unavailable.",
  "reason": "company_unavailable"
}
```

### 404 The id does not exist or is something you cannot see, or the feature is not on for your company (`feature_off`).

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

### 409 The switch cannot run now. `reason` says why: `not_running` (the site is not running normally), `busy` or `command_running` (another change or command is running), `exec_unresolved` (an earlier command on the site has not been confirmed stopped), `deleted`, `provisioning` or `managed_elsewhere`.

```json
{
  "code": "busy",
  "message": "Maintenance mode is being checked. Try again in a moment.",
  "reason": "busy"
}
```

### 422 `enabled` is missing or not true or false (`invalid`).

```json
{
  "code": "invalid",
  "errors": {
    "enabled": [
      "The enabled field must be true or false."
    ]
  },
  "field": "enabled",
  "message": "The enabled field must be true or false.",
  "reason": "invalid"
}
```

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

### 503 Corefinity has switched commands on sites off for the moment (`switched_off`). Try again later.

```json
{
  "code": "switched_off",
  "message": "Site commands are switched off at the moment",
  "reason": "switched_off"
}
```

## If it is refused

| Status | Reason | What to do |
|---|---|---|
| 401 |  | 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. |
| 409 | `busy` | Another operation is running on the site. Wait for it to finish. |
| 409 | `command_running` | Another action or command is still running on the site. Wait for it to finish, then try again. |
| 409 | `deleted` | The site, environment or copy has been deleted, or is being deleted. Nothing can be changed on it. Restore a deleted site first if it can still be restored. |
| 409 | `exec_unresolved` | An earlier command on the site has not been confirmed stopped. Contact support. |
| 409 | `managed_elsewhere` | This site is read-only here. Change it in the control panel that manages it. |
| 409 | `not_running` | The site, environment or deployment is not running. Read the message: where it can be started or will recover, start it or wait, then try again. |
| 409 | `provisioning` | The site is still being created. Try again in a few minutes. |
| 422 | `invalid` | Fix the field named in `field`; `errors` says why. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |
| 503 | `switched_off` | Corefinity has switched this action off for the moment. Try again later. |

## The same task elsewhere

- Guide: [Maintenance mode](https://docs.corefinity.com/guides/sites/create-and-manage/maintenance-mode.md)
- MCP tool: [`corestack_maintenance_mode_set`](https://docs.corefinity.com/mcp/tools/corestack_maintenance_mode_set.md)
