Retrieve cPanel account's log archival settings

This function retrieves the account's log archival settings.

Authorizations:

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --output=jsonpretty \
  --user=username \
  LogManager \
  get_settings

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "get_settings",
  • "module": "LogManager",
  • "result": {
    • "data": {
      • "archive_logs": 1,
      • "prune_archive": 1
      },
    • "errors": null,
    • "messages": null,
    • "metadata": {
      • "transformed": 1
      },
    • "status": 1,
    • "warnings": null
    }
}