CorefinityCorefinityDocs
Open the Control PanelControl Panel
Backups and restores · 5 of 8

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.

POST/api/corestack/sites/{site}/snapshots

Path parameters

siteintegerRequired

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

notestring or null

Up to 140 characters.

Returns

201 The snapshot, which is now being taken.

Fields of the 201 answer
archivedbooleanRequired

True for a snapshot kept from before the site moved storage. Only Corefinity support can restore it.

availableboolean

Whether it can be used as a source now. Sent only while restoring to another environment is on for your company.

can_deletebooleanRequired

Whether you can delete it now.

can_protectbooleanRequired

Whether you can keep it, or stop keeping it, now.

created_atstring or nullRequired

Format: date-time.

delete_reasonstring or any or nullRequired

Why the snapshot was deleted. Null until a delete is asked for.

delete_reason_labelstring or nullRequired
deleted_atstring or nullRequired

Format: date-time.

errorstring or nullRequired

Why the snapshot failed, in plain words.

expires_atstring or nullRequired

When retention removes the snapshot. Null while it is kept or no retention is set. Format: date-time.

idintegerRequired

At least 1.

in_useboolean

Whether a restore or a copy is reading it. Sent only while restoring to another environment is on for your company.

keptboolean

The same as protected. Sent only while restoring to another environment is on for your company.

kindstringRequired

Why the snapshot was taken.

scheduledmanualpre_restorefinalclonepre_deploy
kind_labelstringRequired
mariadb_versionstring or nullRequired
notestring or nullRequired
php_versionstring or nullRequired
protectedbooleanRequired

True while the snapshot is kept.

ready_atstring or nullRequired

Format: date-time.

requested_byobject or any or nullRequired
restorableobjectRequired

What the snapshot can be restored as now, and why not when it cannot.

Fields
databasebooleanRequired
everythingbooleanRequired
filesbooleanRequired
reasonstring or null

Why something cannot be restored, in plain words.

restore_size_bytesinteger or nullRequired

The size of the site the snapshot restores to. Null until it is known.

statusstringRequired

retrying is a scheduled snapshot that failed and will be tried again; retried is a failed attempt that a later one replaced.

pendingcreatingreadyfaileddeletingdeletedretryingretried
status_labelstringRequired
stored_bytesinteger or nullRequired

The space the snapshot uses. Null until it is measured.

unavailable_reasonstring

Why it cannot be used as a source. Sent only when available is false.

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403company_unavailableYour company is unavailable.
403scope_requiredUse a token with the scope named in scope.
403two_factor_requiredTurn on two-factor on your account, then send again.
404noneCheck the id. You see only what your account can reach.
409in_flightA snapshot is already being taken. Wait for it.
409managed_elsewhereThis site is read-only here. Change it in the control panel that manages it.
409mariadb_changeThe 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.
409not_healthyThe site is not running normally. Wait until it is, or contact support.
409stateWhat the request acts on is not in a state that allows this. Read the message.
409removedThe site or environment is being removed, or has been. Nothing can be changed on it.
409restoringA restore is running. Wait for it to finish.
409setting_upThe site was created moments ago and its storage is not ready yet. Try again in a few minutes.
409settlingThe database started moments ago and is still settling. Try again in a few minutes.
409staleWhat you read has changed since you read it. Read it again, then send the change with its new version or quote.
422disabledSnapshots are not enabled for the site or its cluster. Contact support to have them turned on.
422invalidFix the field named in field; errors says why.
429google_capThe hourly snapshot limit was reached. Try again later.
429manual_capThe hourly limit of one-off snapshots for the environment was reached. Try again later.
429rate_limitedWait for the seconds in Retry-After.
502unreadableThe site's state could not be read. Try again shortly.
503stateWhat 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"
  }'
{
  "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
}
Try it

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.

Was this helpful?
Open in ClaudeOpen in ChatGPT