CorefinityCorefinityDocs
Open the Control PanelControl Panel
Snapshots and restores · 11 of 14

corestack_restore_preview

Preview restoring a snapshot elsewhere.

Scope readNo secrets returned
On this page

When to use it

Check a restore before you start it with corestack_snapshot_restore_to: restoring a snapshot into a new environment, another existing environment, production or a new website. The answer lists the target kinds and what blocks each, the plan and its estimate (plan.note is storage_transfer when the copy takes a few minutes), the versions the copy keeps, what is replaced and what production keeps, the safety steps applied to the copy, whether it can be anonymised, whether there is room, the price line for the size and package you chose, the typed confirmation the start will need (confirm.field names its argument, confirm.expected_hint what to type) and anything that blocks the restore now (refusals). plan.php_wait ({message}) is present when the restore would wait for its PHP version, which is not open to new sites yet: tell the person its message — the environment or site will be set up as soon as the version is open, and the restore starts on its own then, so do not promise the estimate meanwhile. Nothing is started.

Ask for it

Prompt
Using the Corefinity MCP server, call corestack_restore_preview with snapshot_id 812, target {"kind":"new_environment","parent_site_id":301,"uat_size":"small"}, anonymise true. (Preview restoring a snapshot elsewhere.) Tell me what it returned.

Inputs

anonymiseboolean

Anonymise the copy. Never offered for production.

scopestring

For an overwrite, everything (the default), files or database.

everythingfilesdatabase
snapshot_idintegerRequired

The snapshot to restore. Find one with corestack_company_snapshots_list or corestack_snapshot_list. At least 1.

targetobjectRequired

kind is existing_environment or production with site_id; new_environment with parent_site_id (and name, uat_size or tier); or new_site with product: corecluster and cluster_id (with tier), or corestack and a placement ({kind: platform, region}) with package and compute_family, and domain. in_place is previewed too; it starts with corestack_restore_create.

Fields
cluster_idinteger

At least 1.

compute_familystring

Up to 32 characters.

domainstring

Up to 253 characters.

kindstringRequired
in_placenew_environmentexisting_environmentproductionnew_site
namestring

Up to 64 characters.

packagestring

Up to 64 characters.

parent_site_idinteger

At least 1.

placementobject
Fields
cluster_idinteger

At least 1.

kindstringRequired
platformcluster
regionstring
productstring
corestackcorecluster
site_idinteger

At least 1.

slugstring
tierstring

Up to 32 characters.

uat_sizestring

Up to 16 characters.

The snapshot's website and the target must both be yours and, for a token with pins, covered by them. A new website is a create, which a token with pins cannot preview.

Example call

tools/call
{
  "name": "corestack_restore_preview",
  "arguments": {
    "snapshot_id": 812,
    "target": {
      "kind": "new_environment",
      "parent_site_id": 301,
      "uat_size": "small"
    },
    "anonymise": true
  }
}

If it is refused

ReasonWhat to do
feature_offRestoring this way, onto a new website or with anonymising, is not switched on for the company.
legacy_searchThe snapshot is of a site whose search runs on a temporary older engine, so it is not restored into production or a new website; switch the store to the OpenSearch module first.
snapshot_transferOver an existing environment or production that runs on other servers than the row the snapshot was taken from, the restore copies the snapshot across, which a saved snapshot is not for now; corestack_snapshot_restore_to would refuse it. Tell the person they can copy the live environment instead (corestack_site_clone without snapshot_id), or restore the snapshot to an environment on the same servers. Where it is switched on and both servers can, a saved snapshot on other servers is sent to the target's servers first instead: plan.note reads storage_transfer and the estimate includes the send (staff see staff.transport sent_local). snapshot_transfer stays for a snapshot the servers cannot send.
snapshot_unavailablefinal_expired, not_offered, invalid_arguments: this snapshot cannot be restored as asked; the message says why (for a WordPress site built with Bedrock that deploys from Git, a target that deploys manually is not_offered: restore only the database, or use a branch (Git) environment).
temporarily_unavailableThe restore cannot be made just now. Nothing was changed; try again in a few minutes.
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.
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