# Backup or Restore

Backups / Backup or Restore

## Return backup transport events' status

 - [GET /backup_get_transport_status](https://api.docs.cpanel.net/specifications/whm.openapi/backup-or-restore/backup_get_transport_status.md): This function retrieves the status of any backup transport events on the account.

## Return backup files sent through transport

 - [GET /backup_list_transported](https://api.docs.cpanel.net/specifications/whm.openapi/backup-or-restore/backup_list_transported.md): This function lists backup files that the system sent through a specified additional backup transport.

## Return backup files in the local disk

 - [GET /backup_set_list](https://api.docs.cpanel.net/specifications/whm.openapi/backup-or-restore/backup_set_list.md): This function lists backup files for the server's accounts in the local disk.

## Return backup files for the server's accounts

 - [GET /backup_set_list_combined](https://api.docs.cpanel.net/specifications/whm.openapi/backup-or-restore/backup_set_list_combined.md): This function lists locally-stored and backup-destination stored backup files for the server's accounts.

## Return start_background_pkgacct session log file

 - [GET /fetch_pkgacct_master_log](https://api.docs.cpanel.net/specifications/whm.openapi/backup-or-restore/fetch_pkgacct_master_log.md): This function returns the contents of a  session's master log file.

## Return start_background_pkgacct session state

 - [GET /get_pkgacct_session_state](https://api.docs.cpanel.net/specifications/whm.openapi/backup-or-restore/get_pkgacct_session_state.md): This function returns the state of a  session.

## Return users and domains with backup metadata

 - [GET /get_users_and_domains_with_backup_metadata](https://api.docs.cpanel.net/specifications/whm.openapi/backup-or-restore/get_users_and_domains_with_backup_metadata.md): This function lists all users and their domains that have backup metadata.

## Return users with backup metadata

 - [GET /get_users_with_backup_metadata](https://api.docs.cpanel.net/specifications/whm.openapi/backup-or-restore/get_users_with_backup_metadata.md): This function lists users with backup metadata.

## Return cparchive files list

 - [GET /list_cparchive_files](https://api.docs.cpanel.net/specifications/whm.openapi/backup-or-restore/list_cparchive_files.md): This function lists all available cparchive files.



*  represents the file's date in month, date, and year format.
*  represents the file's timestamp in hour, minute, and second format.

The function checks the following filenames, where  represents the cPanel account's filusername::
* 
* 
* 
* 
* 
* 
* 

The function checks for these filenames in the following locations:
* 
* 
* 
* 
* 
* 
* 

## Back up an account using the pkgacct script

 - [GET /start_background_pkgacct](https://api.docs.cpanel.net/specifications/whm.openapi/backup-or-restore/start_background_pkgacct.md): This function backs up an account with the pkgacct script.



- The  script logs results to the  directory, where  represents the backup session's ID.
- The target system streams the output of this function with the  script on the source system. Users should  directly call this script.

## Restore one cPanel account from a backup

 - [GET /start_local_cpmove_restore](https://api.docs.cpanel.net/specifications/whm.openapi/backup-or-restore/start_local_cpmove_restore.md): This function performs a full restoration of a single cPanel account from a  tarball.