Enable or disable backups

This function enables and disables the backup and legacy backups.

SecurityBasicAuth
Request
query Parameters
backupversion
required
string

The type of backup.

  • backup - Standard backups.
  • legacy - Legacy backups.
Enum: "backup" "legacy"
Example: backupversion=backup
state
required
integer

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

  • 1 - Enable.
  • 0 - Disable.
Enum: 0 1
Example: state=1
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
get/backup_skip_users_all
Request samples
whmapi1 --output=jsonpretty \
  backup_skip_users_all \
  state='1' \
  backupversion='backup'
Response samples
application/json
{
  • "metadata": {
    • "command": "backup_skip_users_all",
    • "reason": "Configuration update process started",
    • "result": 1,
    • "version": 1
    }
}