---
title: "List a CoreCluster's log sources"
url: https://docs.corefinity.com/api/reference/logs/list-cluster-log-streams
type: endpoint
last_updated: 2026-11-13
feature: logs
related:
  - https://docs.corefinity.com/guides/sites/logs-and-monitoring/logs.md
---
# List a CoreCluster's log sources

Answers the log sources, the limits of a read, the logs quota, the time ranges on offer, and each site of
the CoreCluster with whether its logs are in the read.

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

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

## Query parameters

- `sites` (array of integers): The sites of this CoreCluster to read, by site row id: a list (`sites[]=1042&sites[]=1051`) or one comma-separated value. At most 200. Every site you can see when left out. A site that is not on this CoreCluster, or that you cannot see, answers `404`.
- `environment` (string): `production` reads each site's production environment. `all` reads every environment.

## Request

### curl

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

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

### Node

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

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

## Responses

### 200 The sources, limits, quota and ranges.

```json
{
  "limits": {
    "max_limit": 1000,
    "max_query_bytes": 4096,
    "max_range_days": 30,
    "queries_per_minute": 150,
    "timeout_seconds": 15
  },
  "ranges": [
    "15m",
    "1h",
    "6h",
    "24h",
    "7d",
    "30d"
  ],
  "sites": [
    {
      "available": true,
      "environment": "Production",
      "id": 1042,
      "label": "harbourandfinch.example.com"
    },
    {
      "available": true,
      "environment": "Production",
      "id": 1051,
      "label": "journal.harbourandfinch.example.com"
    }
  ],
  "sources": [
    {
      "available": true,
      "key": "all",
      "label": "All",
      "reason": null
    },
    {
      "available": true,
      "key": "web-access",
      "label": "Web access",
      "reason": null
    },
    {
      "available": true,
      "key": "web-error",
      "label": "Web errors",
      "reason": null
    },
    {
      "available": true,
      "key": "php",
      "label": "PHP",
      "reason": null
    },
    {
      "available": true,
      "key": "app",
      "label": "Application",
      "reason": null
    },
    {
      "available": true,
      "key": "cron",
      "label": "Cron",
      "reason": null
    },
    {
      "available": true,
      "key": "database",
      "label": "Database",
      "reason": null
    },
    {
      "available": true,
      "key": "cache",
      "label": "Cache",
      "reason": null
    },
    {
      "available": false,
      "key": "search",
      "label": "Search",
      "reason": "not_collected"
    },
    {
      "available": false,
      "key": "queue",
      "label": "Queue",
      "reason": "not_collected"
    }
  ],
  "tenant": {
    "percent": 8,
    "quota_gb": 120,
    "retention_days": 30,
    "state": "ok",
    "stored_gb": 10
  },
  "unpack_json": true
}
```

### 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 The read cannot be made. `reason` says why: `logs_not_collected` (logs are not collected for this CoreCluster, or for any site of the read, yet), `query_too_wide` (the read covers too many sites at once) or `logs_scope_split` (the sites keep their logs in different places: choose fewer sites).

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

### 422 A field is missing or wrong. `field` names the first one and `errors` lists every one. Beside the request's own fields, `errors` can name `query` (the LogsQL is not valid, is over 4 KB, uses the `stream_context` pipe or the `time_offset` option, or is an aggregating query sent to an export), `filters.<name>` (a filter is not valid), `filters_max` (too many text or field filters), `cursor` (the cursor is not this request's or this token's) and `saved_max` (you already keep 50 saved queries).

```json
{
  "code": "invalid",
  "errors": {
    "query": [
      "Keep the query under 4 KB."
    ]
  },
  "field": "query",
  "message": "Keep the query under 4 KB.",
  "reason": "invalid"
}
```

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

### 503 The logs store did not answer (`logs_cluster_unavailable`), or it is serving as many reads as it can (`logs_busy`, with `Retry-After`). The request itself is fine: try again shortly.

```json
{
  "code": "logs_busy",
  "message": "Logs are busy at the moment. Try again in a few seconds",
  "reason": "logs_busy"
}
```

## 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. |
| 409 | `logs_scope_split` | These sites keep their logs in different places. Choose a cluster or site. |
| 422 | `invalid` | Fix the field named in `field`; `errors` says why. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |
| 503 | `logs_busy` | Logs are busy at the moment. Try again in a few seconds. |
| 503 | `logs_cluster_unavailable` | Logs are not available at the moment. Try again shortly. |

## The same task elsewhere

- Guide: [Logs](https://docs.corefinity.com/guides/sites/logs-and-monitoring/logs.md)
