---
title: "Get a CoreCluster's snapshot settings"
url: https://docs.corefinity.com/api/reference/backups/get-cluster-snapshot-settings
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/corecluster_snapshot_settings_get.md
---
# Get a CoreCluster's snapshot settings

Answers the default frequency the CoreCluster's sites follow, its snapshot quota and retention, and how much
of the quota is used.

```http
GET /api/corestack/clusters/{cluster}/snapshot-settings
```

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

## Path parameters

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

## Request

### curl

```bash
curl https://manage.corefinity.com/api/corestack/clusters/1017/snapshot-settings \
  -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/clusters/1017/snapshot-settings');

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

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/clusters/1017/snapshot-settings', {
  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/clusters/1017/snapshot-settings",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

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

## Responses

### 200 The CoreCluster's snapshot settings.

```json
{
  "can_change_frequency": true,
  "can_change_limits": false,
  "enabled": true,
  "frequency": "daily",
  "frequency_label": "Daily",
  "frequency_options": [
    {
      "label": "Every hour",
      "value": "1h"
    },
    {
      "label": "Every 2 hours",
      "value": "2h"
    },
    {
      "label": "Every 3 hours",
      "value": "3h"
    },
    {
      "label": "Every 4 hours",
      "value": "4h"
    },
    {
      "label": "Every 6 hours",
      "value": "6h"
    },
    {
      "label": "Every 12 hours",
      "value": "12h"
    },
    {
      "label": "Daily",
      "value": "daily"
    },
    {
      "label": "Weekly",
      "value": "weekly"
    },
    {
      "label": "Monthly",
      "value": "monthly"
    },
    {
      "label": "Off",
      "value": "off"
    }
  ],
  "over_quota": false,
  "protect_cap_bytes": 53687091200,
  "protected_bytes": 6442450944,
  "pruned_recently": false,
  "quota_bytes": 107374182400,
  "retention_days": 30,
  "usage_bytes": 21474836480,
  "usage_synced_at": "2026-11-03T18:00:00Z"
}
```

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