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.
Path parameters
The id of a site row. A website's production site and each of its environments has its own id. Digits only. At least 1.
Body
True switches maintenance mode on, false off.
Returns
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.
Fields of the 200 answer
The command that switched it.
Fields
Format: date-time.
At least 1.
What was asked for.
Fields
Format: date-time.
What the check after the switch found.
Fields
Whether the site answers with the maintenance page.
The address the check asked. Null when no check was made, which is the case when the site was already in the state you asked for.
The status the site answered the check with. Null when no check was made.
Format: date-time.
succeeded, or failed with the reason in error.
The site's maintenance state after the switch.
Fields
Who switched it on.
How many of Corefinity's own addresses still see the site.
Always empty for you. Corefinity's own addresses still see the site and are told to Corefinity staff only; bypass_corefinity counts them.
The last switch, in short.
What the maintenance page tells visitors and search engines to wait.
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. |
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. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
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
}'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();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);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{
"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"
}
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "busy",
"message": "Maintenance mode is being checked. Try again in a moment.",
"reason": "busy"
}{
"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"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}{
"code": "switched_off",
"message": "Site commands are switched off at the moment",
"reason": "switched_off"
}Try it is off for this endpointIt has not been cleared for the console. Copy the request and run it yourself when you are sure.