Skip to main content

Error Logs - Log Clear

Endpoint​

/i/errorlogs

Overview​

Clears (truncates to zero length) a selected Countly server log file.

Authentication​

Countly API supports three authentication methods:

  1. API Key (parameter): api_key=YOUR_API_KEY
  2. Auth Token (parameter): auth_token=YOUR_AUTH_TOKEN
  3. Auth Token (header): countly-token: YOUR_AUTH_TOKEN

Permissions​

  • Required permission: Global Admin.

Request Parameters​

ParameterTypeRequiredDescription
api_keyStringYes (or use auth_token)API key for authentication.
auth_tokenStringNoAuth token as query parameter or countly-token header.
logStringYesLog key to clear (for example api, dashboard, or other discovered countly-*.log keys).

Response​

Success Response​

{
  "result": "Success"
}

Response Fields​

FieldTypeDescription
resultStringSuccess when log file was truncated.

Error Responses​

  • 200 (invalid log key)
{
  "result": "Invalid log"
}
  • 200 (truncate error)
{
  "result": {
    "errno": -2,
    "code": "ENOENT",
    "syscall": "open",
    "path": "/path/to/log/countly-api.log"
  }
}
  • 400
{
  "result": "Missing parameter \"api_key\" or \"auth_token\""
}
  • 400
{
  "result": "Token not valid"
}
  • 401
{
  "result": "User does not exist"
}
  • 401
{
  "result": "User does not have right"
}
  • 401
{
  "result": "User is locked"
}
  • 401
{
  "result": "Token is invalid"
}

Behavior/Processing​

  • Validates global-admin permissions.
  • Discovers available logs from log/ directory (countly-*.log) plus default api and dashboard mappings.
  • Verifies provided log key exists.
  • Dispatches audit event and truncates selected file.

Impact on Other Data​

  • Truncates selected filesystem log file content.

Audit & System Logs​

ActionTriggerPayload
errologs_clearValid log key is accepted for truncate operation{ log: selected_log_key }

Database Collections​

This endpoint does not read or write database collections.

Examples​

Clear API log​

/i/errorlogs?api_key=YOUR_API_KEY&log=api

Clear dashboard log​

/i/errorlogs?api_key=YOUR_API_KEY&log=dashboard

Limitations​

  • Log key must map to a discovered countly-*.log file.
  • Endpoint returns 200 for both success and many operation errors; check result content.

Last Updated​

2026-02-17