v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
LogManager
Logs

Retrieve cPanel account's log archival settings

This function retrieves the account's log archival settings.

get/LogManager/get_settings

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "get_settings",
  "module": "LogManager",
  "result": {
    "data": {
      "archive_logs": 1,
      "prune_archive": 1,
      "retention_days": 30,
      "using_default": 1
    },
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}