---
title: "corestack_restore_preview"
url: https://docs.corefinity.com/mcp/tools/corestack_restore_preview
type: tool
last_updated: 2026-11-13
feature: restores
related:
  - https://docs.corefinity.com/guides/sites/backups/restore-anywhere.md
---
# corestack_restore_preview

**Preview restoring a snapshot elsewhere.** Before corestack_snapshot_restore_to: where a snapshot can be restored, what it replaces and keeps, the safety steps, anonymising, room, the price line, the confirmation the start needs, and what blocks it. Scope: read.

- Scope: `read`
- Runs as a task: no

## 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.

## Inputs

- `snapshot_id` (integer, required): the snapshot to restore. Find one with `corestack_company_snapshots_list` or `corestack_snapshot_list`.
- `target` (object, required): `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`.
- `scope` (string): for an overwrite, `everything` (the default), `files` or `database`.
- `anonymise` (boolean): anonymise the copy. Never offered for production.

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.

### Input schema

```json
{
  "additionalProperties": false,
  "properties": {
    "anonymise": {
      "description": "Anonymise the copy (non-production targets only).",
      "type": "boolean"
    },
    "scope": {
      "description": "An overwrite: what to restore (everything).",
      "enum": [
        "everything",
        "files",
        "database"
      ],
      "type": "string"
    },
    "snapshot_id": {
      "minimum": 1,
      "type": "integer"
    },
    "target": {
      "additionalProperties": false,
      "description": "existing_environment / production: site_id; new_environment: parent_site_id (+ name, uat_size or tier); new_site: product with cluster_id (corecluster) or placement + package (corestack).",
      "properties": {
        "cluster_id": {
          "minimum": 1,
          "type": "integer"
        },
        "compute_family": {
          "maxLength": 32,
          "minLength": 1,
          "type": "string"
        },
        "domain": {
          "maxLength": 253,
          "minLength": 3,
          "type": "string"
        },
        "kind": {
          "enum": [
            "in_place",
            "new_environment",
            "existing_environment",
            "production",
            "new_site"
          ],
          "type": "string"
        },
        "name": {
          "maxLength": 64,
          "minLength": 1,
          "type": "string"
        },
        "package": {
          "maxLength": 64,
          "minLength": 1,
          "type": "string"
        },
        "parent_site_id": {
          "minimum": 1,
          "type": "integer"
        },
        "placement": {
          "additionalProperties": false,
          "properties": {
            "cluster_id": {
              "minimum": 1,
              "type": "integer"
            },
            "kind": {
              "enum": [
                "platform",
                "cluster"
              ],
              "type": "string"
            },
            "region": {
              "pattern": "^[a-z]{2,4}$",
              "type": "string"
            }
          },
          "required": [
            "kind"
          ],
          "type": "object"
        },
        "product": {
          "enum": [
            "corestack",
            "corecluster"
          ],
          "type": "string"
        },
        "site_id": {
          "minimum": 1,
          "type": "integer"
        },
        "slug": {
          "pattern": "^[a-z][a-z0-9-]{1,15}$",
          "type": "string"
        },
        "tier": {
          "maxLength": 32,
          "minLength": 1,
          "type": "string"
        },
        "uat_size": {
          "maxLength": 16,
          "minLength": 1,
          "type": "string"
        }
      },
      "required": [
        "kind"
      ],
      "type": "object"
    }
  },
  "required": [
    "snapshot_id",
    "target"
  ],
  "type": "object"
}
```

## Refusals

- `feature_off`: restoring this way, onto a new website or with anonymising, is not switched on for the company.
- `legacy_search` (message: "This site's search runs on a temporary older engine. Switch the store to the OpenSearch module first."): the 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_transfer` (message: "A saved snapshot can be copied only to an environment on the same servers for now, and these two environments are on different servers. Copy the live environment instead, or restore the snapshot to an environment on the same servers."): over 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_unavailable`, `final_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_unavailable`: the restore cannot be made just now. Nothing was changed; try again in a few minutes.
- The refusals every tool can answer: `invalid_arguments`, `tenant_mismatch`, `scope_required`, `pin_refused`, `rate_limited`, `temporarily_unavailable`, `internal_error` (corestack://guides/how-this-server-works).

## Example

```json
{
  "name": "corestack_restore_preview",
  "arguments": {
    "snapshot_id": 812,
    "target": {
      "kind": "new_environment",
      "parent_site_id": 301,
      "uat_size": "small"
    },
    "anonymise": true
  }
}
```

## Prompt

```text
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.
```

## The same task elsewhere

- Guide: [Restore anywhere](https://docs.corefinity.com/guides/sites/backups/restore-anywhere.md)
