CorefinityCorefinityDocs
Open the Control PanelControl Panel
Maintenance mode · 1 of 1

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.

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

Path parameters

siteintegerRequired

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

enabledbooleanRequired

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
commandobjectRequired

The command that switched it.

Fields
duration_msinteger or null
errorstring or null
exit_codeinteger or null
finished_atstring or null

Format: date-time.

idintegerRequired

At least 1.

inputobject

What was asked for.

Fields
enabledbooleanRequired
kindstringRequired
labelstring
output_excerptstring or null
queued_atstring or null

Format: date-time.

resultobject or null

What the check after the switch found.

Fields
enabledboolean

Whether the site answers with the maintenance page.

host_checkedstring or null

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.

http_codeinteger or null

The status the site answered the check with. Null when no check was made.

started_atstring or null

Format: date-time.

statusstringRequired

succeeded, or failed with the reason in error.

status_labelstring
maintenanceobjectRequired

The site's maintenance state after the switch.

Fields
byany

Who switched it on.

bypass_corefinityinteger

How many of Corefinity's own addresses still see the site.

bypass_ipsarray of strings

Always empty for you. Corefinity's own addresses still see the site and are told to Corefinity staff only; bypass_corefinity counts them.

commandany

The last switch, in short.

enabledbooleanRequired
pagestring or null
retry_after_secondsinteger or null

What the maintenance page tells visitors and search engines to wait.

sincestring or null

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403company_unavailableYour company is unavailable.
403scope_requiredUse a token with the scope named in scope.
403two_factor_requiredTurn on two-factor on your account, then send again.
404feature_offThis feature is not on for your organisation yet.
409busyAnother operation is running on the site. Wait for it to finish.
409command_runningAnother action or command is still running on the site. Wait for it to finish, then try again.
409deletedThe 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.
409exec_unresolvedAn earlier command on the site has not been confirmed stopped. Contact support.
409managed_elsewhereThis site is read-only here. Change it in the control panel that manages it.
409not_runningThe 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.
409provisioningThe site is still being created. Try again in a few minutes.
422invalidFix the field named in field; errors says why.
429rate_limitedWait for the seconds in Retry-After.
503switched_offCorefinity 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
  }'
{
  "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"
  }
}
Try it

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.

Was this helpful?
Open in ClaudeOpen in ChatGPT