CorefinityCorefinityDocs
Open the Control PanelControl Panel
Migration aids · 6 of 6

corestack_site_copy_hold_set

Hold or release a copy.

Scope writeRuns as a taskNo secrets returned
On this page

When to use it

Hold or release a target row while you copy a site into it. consumers: true stops the queue workers and the scheduled tasks starting anything (work the copy queues itself waits too) and completes only once the running work has finished; web: true answers "temporarily unavailable" (503) to every visitor, Corefinity's office included, and completes only once no request is in flight. WP-CLI, bin/magento, artisan, bin/console and your commands keep working. Hold consumers from before the first import until the cutover, and web around every import. A hold stays until you release it with false, or the person releases it from the dashboard: nothing else releases it. If the work does not finish in time the task fails and the hold stays on. The finished task's web_drain says how a web hold was proven: fpm_nginx means php-fpm and nginx were both seen quiet (Laravel, Magento 2 and Shopware, and WordPress on PHP 8.0 or later where its runtime has the php-fpm status listener); nginx means nginx was seen quiet and the site's longest allowed request time had passed, so it takes longer.

Ask for it

Prompt
Using the Corefinity MCP server, call corestack_site_copy_hold_set with site_id 4211, consumers true, web true. (Hold or release a copy.) Tell me what it returned.

Inputs

consumersboolean

true holds the queue workers and scheduled tasks, false releases them; leave out to keep as it is.

site_idintegerRequired

At least 1.

webboolean

true answers 503 to every visitor, false releases it; leave out to keep as it is.

Example call

tools/call
{
  "name": "corestack_site_copy_hold_set",
  "arguments": {
    "site_id": 4211,
    "consumers": true,
    "web": true
  }
}

If it is refused

ReasonWhat to do
switched_offThe exec or delete kill switch is off; stop; tell the person.
runtime_not_adoptedThe copy hold's two barriers ship in the runtime component, and this row is not adopted yet; nothing was signed. A new target is born adopted; adopt the row with corestack_runtime_adopt, then hold.
busyAnother change is running on this row; wait for it (corestack_site_operation_get) and call again.
conflictconsumers: false on the new environment of a move that has not gone live yet; its queue workers and scheduled tasks stay paused until the move goes live, which releases them; nothing was changed. Do not retry; tell the person.
work_failedThe task's operation or deployment ended failed; details carries the record; read details; the person may retry with corestack_operation_retry where it applies.
managed_elsewhereAnother control panel manages this site, so use that control panel for it. This is refused before anything else about the site, as in the Control Panel and the API. Nothing was done.
invalid_argumentsThe arguments do not match the tool's input schema, or the Control Panel refused a field. Fix the fields named in the answer and call again.
tenant_mismatchThe object does not exist or the token may not see it. Check the id.
scope_requiredThe token lacks a scope this call needs. Open the link in the answer to add it, then call again.
pin_refusedThe grant is limited to chosen clusters, sites or environments, and this call is outside them. Open the link in the answer to widen it.
rate_limitedToo many calls. Wait for the number of seconds the answer names.
temporarily_unavailableThe Control Panel could not answer just now. Nothing was started; try again shortly.
internal_errorSomething went wrong on our side. Quote the trace id to support.

The same task elsewhere

Was this helpful?
Open in ClaudeOpen in ChatGPT