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.
Path parameters
The id of a snapshot. Digits only. At least 1.
Body
Null clears the note. Up to 140 characters.
True keeps the snapshot until you stop keeping it.
Returns
200 The snapshot as it is now.
Fields of the 200 answer
True for a snapshot kept from before the site moved storage. Only Corefinity support can restore it.
Whether it can be used as a source now. Sent only while restoring to another environment is on for your company.
Whether you can delete it now.
Whether you can keep it, or stop keeping it, now.
Format: date-time.
Why the snapshot was deleted. Null until a delete is asked for.
Format: date-time.
Why the snapshot failed, in plain words.
When retention removes the snapshot. Null while it is kept or no retention is set. Format: date-time.
At least 1.
Whether a restore or a copy is reading it. Sent only while restoring to another environment is on for your company.
The same as protected. Sent only while restoring to another environment is on for your company.
Why the snapshot was taken.
scheduledmanualpre_restorefinalclonepre_deployTrue while the snapshot is kept.
Format: date-time.
What the snapshot can be restored as now, and why not when it cannot.
Fields
Why something cannot be restored, in plain words.
The size of the site the snapshot restores to. Null until it is known.
retrying is a scheduled snapshot that failed and will be tried again; retried is a failed attempt that a later one replaced.
pendingcreatingreadyfaileddeletingdeletedretryingretriedThe space the snapshot uses. Null until it is measured.
Why it cannot be used as a source. Sent only when available is false.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | 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 | none | 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. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
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
}'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();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);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{
"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
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"message": "Not found."
}{
"code": "state",
"message": "This snapshot has been deleted",
"reason": "state"
}{
"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"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}