---
title: "Create a snapshot"
url: https://docs.corefinity.com/api/reference/backups/create-site-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_create.md
---
# 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`.

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

- Scope: `write`
- Two-factor: required on your account (all)
- Rate limit: 10 a minute
- Try it in the console: off. It has not been cleared for the console. Copy the request and run it yourself when you are sure.

## Path parameters

- `site` (integer, required): The id of a site row. A website's production site and each of its environments has its own id. Digits only.

## Body

- `note` (string or null)

## Request

### curl

```bash
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"
  }'
```

### PHP

```php
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();
```

### Node

```javascript
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);
```

### Python

```python
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
```

## Responses

### 201 The snapshot, which is now being taken.

```json
{
  "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
}
```

### 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 No snapshot can be taken now. `reason` says why: `in_flight` (one is already being taken), `restoring` (a restore is running), `mariadb_change` (the MariaDB version is changing), `not_healthy` or `settling` (the database is not running normally, or started a few minutes ago), `setting_up` (the site is still being set up), `stale` (the site changed while the snapshot was being prepared), `removed`, `managed_elsewhere`, or `state` (the message says why). When the site's storage does not accept the snapshot, the answer is `state` with the message "The snapshot could not be taken" and the status the storage gave, which is usually `409` and can be another `4xx` status: go by the `reason` and the message, not the status alone.

```json
{
  "code": "in_flight",
  "message": "A snapshot of this site is already being taken. Try again in a minute.",
  "reason": "in_flight"
}
```

### 422 The `note` is wrong (`invalid`), or snapshots are not enabled for the site's cluster (`disabled`).

```json
{
  "code": "disabled",
  "message": "Snapshots are not enabled for this cluster",
  "reason": "disabled"
}
```

### 429 Too many requests (`rate_limited`), the site's hourly limit of one-off snapshots (`manual_cap`), or the hourly limit of all snapshots of the site (`google_cap`).

```json
{
  "code": "google_cap",
  "message": "Snapshot limit reached for this hour. Try again later.",
  "reason": "google_cap"
}
```

### 502 The site could not be checked before the snapshot (`unreadable`). Try again in a minute.

```json
{
  "code": "unreadable",
  "message": "The site could not be checked. Try again in a minute.",
  "reason": "unreadable"
}
```

### 503 Snapshots of this site are temporarily unavailable (`state`). Try again later.

```json
{
  "code": "state",
  "message": "Storage operations for this site are temporarily unavailable. Try again later or contact support.",
  "reason": "state"
}
```

## 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 | `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. |

## The same task elsewhere

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