Create a snapshot
Starts a one-off snapshot of the site and answers it with status pending or creating. Read it with GET /corestack/snapshots/{snapshot} until status is ready or failed.
Path parameters
The id of a site row. A website's production site and each of its environments has its own id. Digits only. At least 1.
Body
Up to 140 characters.
Returns
201 The snapshot, which is now being taken.
Fields of the 201 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 | in_flight | A snapshot is already being taken. Wait for it. |
409 | managed_elsewhere | This site is read-only here. Change it in the control panel that manages it. |
409 | mariadb_change | The database version is changing, or the snapshot's database version does not fit the environment. Read the message: wait for the change to finish, or restore into a new environment. |
409 | not_healthy | The site is not running normally. Wait until it is, or contact support. |
409 | state | What the request acts on is not in a state that allows this. Read the message. |
409 | removed | The site or environment is being removed, or has been. Nothing can be changed on it. |
409 | restoring | A restore is running. Wait for it to finish. |
409 | setting_up | The site was created moments ago and its storage is not ready yet. Try again in a few minutes. |
409 | settling | The database started moments ago and is still settling. Try again in a few minutes. |
409 | stale | What you read has changed since you read it. Read it again, then send the change with its new version or quote. |
422 | disabled | Snapshots are not enabled for the site or its cluster. Contact support to have them turned on. |
422 | invalid | Fix the field named in field; errors says why. |
429 | google_cap | The hourly snapshot limit was reached. Try again later. |
429 | manual_cap | The hourly limit of one-off snapshots for the environment was reached. Try again later. |
429 | rate_limited | Wait for the seconds in Retry-After. |
502 | unreadable | The site's state could not be read. Try again shortly. |
503 | state | What the request acts on is not in a state that allows this. Read the message. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl -X POST https://manage.corefinity.com/api/corestack/sites/1042/snapshots \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"note": "Before the PHP 8.4 move"
}'use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->post('https://manage.corefinity.com/api/corestack/sites/1042/snapshots', [
'note' => 'Before the PHP 8.4 move',
]);
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/snapshots', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
'Content-Type': 'application/json',
},
body: JSON.stringify({
note: 'Before the PHP 8.4 move',
}),
});
// 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.post(
"https://manage.corefinity.com/api/corestack/sites/1042/snapshots",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
json={
"note": "Before the PHP 8.4 move",
},
)
data = res.json() if res.content else None{
"archived": false,
"can_delete": false,
"can_protect": false,
"created_at": "2026-11-03T16:02:11Z",
"delete_reason": null,
"delete_reason_label": null,
"deleted_at": null,
"error": null,
"expires_at": "2026-12-03T16:02:11Z",
"id": 3302,
"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": null,
"requested_by": {
"id": 2041,
"name": "Eleanor Finch"
},
"restorable": {
"database": false,
"everything": false,
"files": false,
"reason": "This snapshot is still being taken"
},
"restore_size_bytes": null,
"status": "creating",
"status_label": "Creating…",
"stored_bytes": null
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"message": "Not found."
}{
"code": "in_flight",
"message": "A snapshot of this site is already being taken. Try again in a minute.",
"reason": "in_flight"
}{
"code": "disabled",
"message": "Snapshots are not enabled for this cluster",
"reason": "disabled"
}{
"code": "google_cap",
"message": "Snapshot limit reached for this hour. Try again later.",
"reason": "google_cap"
}{
"code": "unreadable",
"message": "The site could not be checked. Try again in a minute.",
"reason": "unreadable"
}{
"code": "state",
"message": "Storage operations for this site are temporarily unavailable. Try again later or contact support.",
"reason": "state"
}Try it is off for this endpointIt has not been cleared for the console. Copy the request and run it yourself when you are sure.