Description


This function enables and disables the backup and legacy backups.


Examples 




https://hostname.example.com:2087/cpsess##########/json-api/backup_skip_users_all?api.version=1&state=1&backupversion=backup




https://hostname.example.com:2087/cpsess##########/xml-api/backup_skip_users_all?api.version=1&state=1&backupversion=backup




whmapi1 backup_skip_users_all state=1 backupversion=backup



{
    "metadata": {
        "version": 1,
        "reason": "Configuration update process started",
        "result": 1,
        "command": "backup_skip_users_all"
    }
}




<result>
   <metadata>
      <version>1</version>
      <reason>Configuration update process started</reason>
      <result>1</result>
      <command>backup_skip_users_all</command>
   </metadata>
</result>



Parameters

ParameterTypeDescriptionPossible valuesExample
stateBoolean

Required

Whether to enable the backup type that the backupversion parameter specifies for all users.

  • 1 — Enable.
  • 0 — Disable.
1
backupversionstring

Required

The type of backup.

  • backup
  • legacy
backup

Returns

This function only returns metadata.