CorefinityCorefinityDocs
Open the Control PanelControl Panel
Logs · 4 of 25

List a CoreCluster's log fields

Answers the fields the lines of a source carry in the time range (the last 24 hours when left out), each with its type and its five most frequent values. The answer is kept for a minute.

GET/api/corestack/clusters/{cluster}/logs/fields

Path parameters

clusterintegerRequired

The id of a CoreCluster. Digits only. At least 1.

Query parameters

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

environmentstring

production reads each site's production environment. all reads every environment. Defaults to production.

productionall
sourcestring

The log source to read. Defaults to all.

allweb-accessweb-errorphpappcrondatabasecachesearchqueue
rangestring

How far back from now to read. Ignored when from is sent.

15m1h6h24h7d30d
fromstring

The start of the time range, as a date and time. It must be inside the time your logs are kept for.

tostring

The end of the time range, as a date and time. Now when left out.

Returns

200 The fields.

Fields of the 200 answer
fieldsarray of objectsRequired
Fields of each item
namestringRequired
toparray of objectsRequired

Up to five most frequent values.

Fields of each item
countintegerRequired
valuestringRequired
typestringRequired

What the field's most frequent values look like.

stringnumberbool
rangeobjectRequired

The exact time range that was read. Send from and to back to read the same range again.

Fields
fromstringRequired

Format: date-time.

tostringRequired

Format: date-time.

sourcestringRequired

A log source. all reads every source. search and queue exist only on platforms that run them; the sources list says which ones an environment has. Defaults to all.

allweb-accessweb-errorphpappcrondatabasecachesearchqueue

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403company_unavailableYour company is unavailable.
403scope_requiredUse a token with the scope named in scope.
403two_factor_requiredTurn on two-factor on your account, then send again.
404feature_offThis feature is not on for your organisation yet.
409logs_not_collectedLogs are not being collected for the environment yet. Try again later, or contact support.
409logs_rangeThe time range is outside the days logs are kept for. Choose a range inside the days the message names.
409logs_scope_splitThese sites keep their logs in different places. Choose a cluster or site.
409query_too_wideThe search covers too much. Choose a shorter range or a narrower search.
422invalidFix the field named in field; errors says why.
429rate_limitedWait for the seconds in Retry-After.
503logs_busyLogs are busy at the moment. Try again in a few seconds.
503logs_cluster_unavailableLogs are not available at the moment. Try again shortly.

Reasons are listed by name in Errors and refusals.

The same task elsewhere

curl https://manage.corefinity.com/api/corestack/clusters/1017/logs/fields \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "fields": [
    {
      "name": "level",
      "top": [
        {
          "count": 41203,
          "value": "info"
        },
        {
          "count": 17,
          "value": "error"
        }
      ],
      "type": "string"
    },
    {
      "name": "method",
      "top": [
        {
          "count": 39870,
          "value": "GET"
        },
        {
          "count": 1350,
          "value": "POST"
        }
      ],
      "type": "string"
    },
    {
      "name": "status",
      "top": [
        {
          "count": 41203,
          "value": "200"
        },
        {
          "count": 812,
          "value": "404"
        },
        {
          "count": 17,
          "value": "500"
        }
      ],
      "type": "number"
    }
  ],
  "range": {
    "from": "2026-11-03T09:00:00Z",
    "to": "2026-11-03T10:00:00Z"
  },
  "source": "web-access"
}
Try it
Held in this tab's memory only. Never stored or sent to us.

Use a token with only the read scope. How to make one

Was this helpful?
Open in ClaudeOpen in ChatGPT