Return backup configuration file data

This function retrieves your backup destination configuration file data.

Authorizations:

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  backup_config_get

Response samples

Content type
application/json
{
  • "data": {
    • "backup_config": {
      • "backup_daily_enable": 1,
      • "backup_daily_retention": 5,
      • "backup_monthly_dates": "1,15,22",
      • "backup_monthly_enable": 0,
      • "backup_monthly_retention": 5,
      • "backup_weekly_day": "1,3,5",
      • "backup_weekly_enable": 0,
      • "backup_weekly_retention": 4,
      • "backupaccts": 1,
      • "backupbwdata": 1,
      • "backupdays": "0,2,4,6",
      • "backupdir": "/backup",
      • "backupenable": 1,
      • "backupfiles": 1,
      • "backuplogs": 0,
      • "backupmount": 0,
      • "backupsuspendedaccounts": 0,
      • "backuptype": "compressed",
      • "check_min_free_space": 1,
      • "disable_metadata": 0,
      • "errorthreshhold": 3,
      • "force_prune_daily": 0,
      • "force_prune_monthly": 0,
      • "force_prune_weekly": 0,
      • "gziprsyncopts": "--rysncable",
      • "keeplocal": 1,
      • "linkdest": 0,
      • "localzonesonly": 0,
      • "maximum_restore_timeout": 21600,
      • "maximum_timeout": 7200,
      • "min_free_space": 1024,
      • "min_free_space_unit": "MB",
      • "mysqlbackup": "accounts",
      • "postbackup": 0,
      • "prebackup": 1,
      • "psqlbackup": 0,
      • "remote_restore_staging_dir": "/backup"
      }
    },
  • "metadata": {
    • "command": "backup_config_get",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}