We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Page tree
Skip to end of metadata
Go to start of metadata


Use the /usr/local/cpanel/bin/backup script to run a backup in WHM via the command line.

Run a manual backup

To run a backup manually, log in to the command line via SSH as the root user and run the following command:



The /usr/local/cpanel/bin/backup script accepts the following options:

--forcePerforms an additional backup, even if the system already contains up-to-date backup files.
/usr/local/cpanel/bin/backup --force
--debugRuns the backup in the foreground and prints its progress on the command line.
/usr/local/cpanel/bin/backup --debug
--helpDisplays additional information.
/usr/local/cpanel/bin/backup --help

Create a  cpmove archive for an account

You can use the /usr/local/cpanel/scripts/pkgacct script to create a cpmove archive for an account. For more information, read The pkgacct Script documentation.

To use a custom packaging script, perform the following steps:

  1. Copy the /usr/local/cpanel/scripts/pkgacct file and modify it.
  2. Store the modified pkgacct file in the /var/cpanel/lib/Whostmgr/Pkgacct/pkgacct directory.
  3. Run the /usr/local/cpanel/bin/backup command with the --allow-override flag.

Additional documentation

There is no content with the specified labels

There is no content with the specified labels

There is no content with the specified labels