CPcpanel
Backups
Backup Settings

Enable or disable legacy backups

This function enables or disables legacy backups for a user.

get/toggle_user_backup_state

Request

  • Base URL
    https://whm-server.tld:2087/json-api
  • Auth
    HTTP basic

Query parameters

userstring username required
Example:username

The cPanel account's username.

legacy0 | 1

Whether the account should use the legacy backup system.

  • 1 - Use the legacy backup system.
  • 0 - Use the standard backup system.

Response

HTTP Request was successful.

Example response

{
  "metadata": {
    "command": "toggle_user_backup_state",
    "reason": "Backup state modified",
    "result": 1,
    "version": 1
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.