---
title: "Get a CoreCluster's logs usage"
url: https://docs.corefinity.com/api/reference/logs/get-cluster-log-usage
type: endpoint
last_updated: 2026-11-13
feature: logs
related:
  - https://docs.corefinity.com/guides/sites/logs-and-monitoring/logs.md
  - https://docs.corefinity.com/mcp/tools/corecluster_logs_usage_get.md
---
# Get a CoreCluster's logs usage

Answers the logs quota of the CoreCluster, what is stored, how long lines are kept, 30 days of daily figures
and the share of each site you can see. This endpoint is available whenever logs are, also while the other
CoreCluster logs endpoints are not.

```http
GET /api/corestack/clusters/{cluster}/logs/usage
```

- 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/logs/usage \
  -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/logs/usage');

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

### Node

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

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

## Responses

### 200 The usage.

```json
{
  "by_environment": [
    {
      "environment": {
        "env_id": "harbourandfinch-example-com",
        "hostname": "harbourandfinch-example-com.northwind.cfstack.example.net",
        "id": 1042,
        "name": "Production",
        "role": "production",
        "role_label": "Production",
        "slug": "production"
      },
      "percent": 61,
      "stored_bytes": 61000000000
    },
    {
      "environment": {
        "env_id": "journal-harbourandfinch-example-com",
        "hostname": "journal-harbourandfinch-example-com.northwind.cfstack.example.net",
        "id": 1051,
        "name": "Production",
        "role": "production",
        "role_label": "Production",
        "slug": "production"
      },
      "percent": 39,
      "stored_bytes": 39400000000
    }
  ],
  "daily": [
    {
      "day": "2026-11-01",
      "ingested_bytes": 12400000000,
      "rows": 9800000,
      "stored_bytes": 3100000000
    },
    {
      "day": "2026-11-02",
      "ingested_bytes": 12800000000,
      "rows": 10100000,
      "stored_bytes": 3200000000
    },
    {
      "day": "2026-11-03",
      "ingested_bytes": 5100000000,
      "rows": 4000000,
      "stored_bytes": 1270000000
    }
  ],
  "forecast": {
    "days_to_quota": 6,
    "next_enforce_at": "2026-11-04T02:00:00Z"
  },
  "percent": 84,
  "quota": {
    "included_gb": 100,
    "purchased_gb": 20
  },
  "quota_gb": 120,
  "retention_days": 30,
  "stored_gb": 100.4,
  "tenant": {
    "owner": {
      "ref": {
        "id": 1017,
        "name": "Northwind UK 1"
      },
      "type": "corecluster"
    },
    "state": "warning"
  }
}
```

### 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 is something you cannot see, or the feature is not on for your company (`feature_off`).

```json
{
  "code": "feature_off",
  "message": "Not found.",
  "reason": "feature_off"
}
```

### 409 Logs are not collected for this environment, site or CoreCluster yet (`logs_not_collected`).

```json
{
  "code": "logs_not_collected",
  "message": "Logs are not being collected for this environment yet",
  "reason": "logs_not_collected"
}
```

### 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 | `feature_off` | This feature is not on for your organisation yet. |
| 409 | `logs_not_collected` | Logs are not being collected for the environment yet. Try again later, or contact support. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |

## The same task elsewhere

- Guide: [Logs](https://docs.corefinity.com/guides/sites/logs-and-monitoring/logs.md)
- MCP tool: [`corecluster_logs_usage_get`](https://docs.corefinity.com/mcp/tools/corecluster_logs_usage_get.md)
