# BackupInfo

The BackupInfo module for UAPI.

## Return cPanel account backups

 - [GET /BackupInfo/list](https://api.docs.cpanel.net/specifications/cpanel.openapi/backupinfo/backupinfo-list.md): This function returns one entry for each cPanel account backup archive
in the current cPanel account's home directory.

Note:
The function derives each archive's status from the on-disk marker file
that cPanel writes while a backup runs. It is the single source of truth
for the list of available backups.

## Return account backup progress

 - [GET /BackupInfo/progress](https://api.docs.cpanel.net/specifications/cpanel.openapi/backupinfo/backupinfo-progress.md): This function returns progress information for a cPanel account backup.

Note:
When the PkgAcct::Create hook is installed, that hook anchors the
run's start and finish, and the function reports complete only after
it confirms the published archive in the home directory, along with the
archive's exact final size. A run that never publishes an archive is
therefore never reported as complete. Without the hook, the function
falls back to the on-disk marker file. When no run is active, the
state return value is none and the other return values are 0 or
null. When the function cannot determine the account's disk usage, the
estimatedTotalBytes and estimatedPercent return values are 0 even
while a run is active.

## Remove backup progress record

 - [GET /BackupInfo/reset](https://api.docs.cpanel.net/specifications/cpanel.openapi/backupinfo/backupinfo-reset.md): This function clears the authoritative run-state record, so that the
BackupInfo::progress function stops reporting a complete state that
persists across polls.

Note:
After a reset, the BackupInfo::progress function reflects only live
state. It reports inprogress while a run is genuinely active and
none otherwise. This function is idempotent and succeeds whether or
not a record exists.