---
title: "Get a snapshot"
url: https://docs.corefinity.com/api/reference/backups/get-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_get.md
---
# Get a snapshot

Answers one snapshot. While it is being taken or deleted, a read checks its progress first when the last check
is more than a few seconds old, so polling this endpoint follows it to `ready`, `failed` or `deleted`.

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

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

## Path parameters

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

## Request

### curl

```bash
curl https://manage.corefinity.com/api/corestack/snapshots/3301 \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
```

### PHP

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

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->get('https://manage.corefinity.com/api/corestack/snapshots/3301');

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

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/snapshots/3301', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
  },
});

// 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.get(
    "https://manage.corefinity.com/api/corestack/snapshots/3301",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

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

## Responses

### 200 The snapshot.

```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."
}
```

### 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. |
| 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_get`](https://docs.corefinity.com/mcp/tools/corestack_snapshot_get.md)
