---
title: "Update a snapshot's note or keep"
url: https://docs.corefinity.com/api/reference/backups/update-snapshot
type: endpoint
last_updated: 2026-11-13
feature: snapshots
related:
  - https://docs.corefinity.com/guides/sites/backups/snapshots.md
  - https://docs.corefinity.com/mcp/tools/corestack_snapshot_update.md
---
# Update a snapshot's note or keep

Sets the snapshot's `note`, keeps it (`protected` true) or stops keeping it. A kept snapshot is not removed by
retention or by the quota. Both fields are optional.

```http
PATCH /api/corestack/snapshots/{snapshot}
```

- Scope: `write`
- Two-factor: required on your account (all)
- Rate limit: 30 a minute
- Try it in the console: on

## Path parameters

- `snapshot` (integer, required): The id of a snapshot. Digits only.

## Body

- `note` (string or null): Null clears the note.
- `protected` (boolean): True keeps the snapshot until you stop keeping it.

## Request

### curl

```bash
curl -X PATCH https://manage.corefinity.com/api/corestack/snapshots/3301 \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "note": null
  }'
```

### PHP

```php
use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->patch('https://manage.corefinity.com/api/corestack/snapshots/3301', [
        'note' => null,
    ]);

$data = $response->json();
```

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/snapshots/3301', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    note: null,
  }),
});

// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);
```

### Python

```python
import os
import requests

res = requests.patch(
    "https://manage.corefinity.com/api/corestack/snapshots/3301",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
    json={
        "note": None,
    },
)

data = res.json() if res.content else None
```

## Responses

### 200 The snapshot as it is now.

```json
{
  "archived": false,
  "can_delete": true,
  "can_protect": true,
  "created_at": "2026-11-03T15:12:40Z",
  "delete_reason": null,
  "delete_reason_label": null,
  "deleted_at": null,
  "error": null,
  "expires_at": "2026-12-03T15:12:40Z",
  "id": 3301,
  "kind": "manual",
  "kind_label": "One-off",
  "mariadb_version": "11.8",
  "note": "Before the PHP 8.4 move",
  "php_version": "8.3",
  "protected": false,
  "ready_at": "2026-11-03T15:14:02Z",
  "requested_by": {
    "id": 2041,
    "name": "Eleanor Finch"
  },
  "restorable": {
    "database": true,
    "everything": true,
    "files": true,
    "reason": null
  },
  "restore_size_bytes": 6442450944,
  "status": "ready",
  "status_label": "Ready",
  "stored_bytes": 1288490188
}
```

### 401 No token, or a token that is not valid.

```json
{
  "message": "Unauthenticated."
}
```

### 403 The token lacks the scope (`scope_required`, with the `scope` to use), your company requires two-factor authentication and you have not set it up, or your account has no company that can use Managed Clusters, for example because the company was closed (`company_unavailable` or `company_not_enabled`, whichever the route checks first). For Managed Clusters routes; any other route uses `ForbiddenScopeOrTwoFactor`.

```json
{
  "code": "company_unavailable",
  "message": "Your company is unavailable.",
  "reason": "company_unavailable"
}
```

### 404 The id does not exist, or it is something you cannot see. Both answer the same body.

```json
{
  "message": "Not found."
}
```

### 409 The snapshot cannot be changed now (`state`). The message says why: it has been deleted, it is the final snapshot of a deleted site, or it cannot be kept.

```json
{
  "code": "state",
  "message": "This snapshot has been deleted",
  "reason": "state"
}
```

### 422 A field is wrong (`invalid`), the snapshot cannot be kept (`state`: it is not ready, or its size is not known yet), or kept snapshots already use your whole keep allowance (the examples show the reason it answers).

```json
{
  "code": "invalid",
  "errors": {
    "note": [
      "The note may not be greater than 140 characters."
    ]
  },
  "field": "note",
  "message": "The note may not be greater than 140 characters.",
  "reason": "invalid"
}
```

### 429 Too many requests (`rate_limited`). Wait for the number of seconds in `Retry-After`, which `retry_after_seconds` repeats.

```json
{
  "code": "rate_limited",
  "message": "Too many requests. Try again in 60 seconds.",
  "reason": "rate_limited",
  "retry_after_seconds": 60
}
```

## If it is refused

| Status | Reason | What to do |
|---|---|---|
| 401 |  | Send a valid token as `Authorization: Bearer <token>`. |
| 403 | `company_unavailable` | Your company is unavailable. |
| 403 | `scope_required` | Use a token with the scope named in `scope`. |
| 403 | `two_factor_required` | Turn on two-factor on your account, then send again. |
| 404 |  | Check the id. You see only what your account can reach. |
| 409 | `state` | What the request acts on is not in a state that allows this. Read the message. |
| 422 | `invalid` | Fix the field named in `field`; `errors` says why. |
| 422 | `keep_cap_reached` | Kept snapshots already use the most space allowed. Stop keeping another snapshot first. |
| 422 | `state` | What the request acts on is not in a state that allows this. Read the message. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |

## The same task elsewhere

- Guide: [Backups](https://docs.corefinity.com/guides/sites/backups/snapshots.md)
- MCP tool: [`corestack_snapshot_update`](https://docs.corefinity.com/mcp/tools/corestack_snapshot_update.md)
