---
title: "corestack_snapshot_update"
url: https://docs.corefinity.com/mcp/tools/corestack_snapshot_update
type: tool
last_updated: 2026-11-13
feature: snapshots
related:
  - https://docs.corefinity.com/api/reference/backups/update-snapshot.md
  - https://docs.corefinity.com/guides/sites/backups/snapshots.md
---
# corestack_snapshot_update

**Change a snapshot.** Change a snapshot's note, or protect it so retention never deletes it (or unprotect it). Scope: write.

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

## When to use it

Change a snapshot's note, or protect it so retention never deletes it (or unprotect it).

## Inputs

- `snapshot_id` (integer, ≥ 1, required)
- `note` (string, or null, up to 140 characters): The new note; null clears it.
- `protected` (boolean): Keep it until it is unprotected or deleted by hand. While keeping native snapshots is switched on, it works on native snapshots too, where the storage is asked first.

### Input schema

```json
{
  "additionalProperties": false,
  "properties": {
    "note": {
      "description": "The new note; null clears it.",
      "maxLength": 140,
      "type": [
        "string",
        "null"
      ]
    },
    "protected": {
      "description": "Keep it until it is unprotected or deleted by hand.",
      "type": "boolean"
    },
    "snapshot_id": {
      "minimum": 1,
      "type": "integer"
    }
  },
  "required": [
    "snapshot_id"
  ],
  "type": "object"
}
```

## Refusals

- `keep_cap_reached` (only while keeping native snapshots is switched on): kept snapshots already use the most space allowed; stop keeping another snapshot first, then try again.
- `managed_elsewhere` (message: "This site is managed by another control panel"): another 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.
- 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_snapshot_update",
  "arguments": {
    "snapshot_id": 9051
  }
}
```

## Prompt

```text
Using the Corefinity MCP server, call corestack_snapshot_update with snapshot_id 9051. (Change a snapshot.) Tell me what it returned.
```

## The same task elsewhere

- Endpoint: [PATCH /api/corestack/snapshots/{snapshot}](https://docs.corefinity.com/api/reference/backups/update-snapshot.md)
- Guide: [Backups](https://docs.corefinity.com/guides/sites/backups/snapshots.md)
