# cPanel Backups API

**Canonical:** https://apis.io/apis/cpanel/cpanel-backups-api/  
**Provider:** cPanel — https://apis.io/providers/cpanel/  
**Base URL:** https://{host}:2083/execute  
**Documentation:** https://api.docs.cpanel.net/cpanel/introduction/

cPanel Backups API is one of 144 APIs that [cPanel](https://apis.io/providers/cpanel/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Backups. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

The Backups module for WHM API 1.

## Operations (27)

| Method | Path | Summary |
|---|---|---|
| GET | `/backup_config_get` | Return backup configuration file data |
| GET | `/backup_config_set` | Update the system's backup configuration |
| GET | `/backup_date_list` | Return dates where backup files exist |
| GET | `/backup_destination_add` | Add a backup destination |
| GET | `/backup_destination_delete` | Delete a backup destination |
| GET | `/backup_destination_get` | Return a backup destination's settings |
| GET | `/backup_destination_list` | Return a list of backup destinations |
| POST | `/backup_destination_set` | Update backup destination settings |
| GET | `/backup_destination_validate` | Validate a backup destination |
| GET | `/backup_does_client_id_have_google_credentials` | Return Google Drive™ client ID credentials |
| GET | `/backup_generate_google_oauth_uri` | Create Google Drive™ OAuth redirect URI |
| GET | `/backup_get_transport_status` | Return backup transport events' status |
| GET | `/backup_list_transported` | Return backup files sent through transport |
| GET | `/backup_set_list` | Return backup files in the local disk |
| GET | `/backup_set_list_combined` | Return backup files for the server's accounts |
| GET | `/backup_skip_users_all` | Enable or disable backups |
| GET | `/backup_skip_users_all_status` | Return backup configuration status |
| GET | `/backup_user_list` | Return users with a backup file |
| GET | `/convert_and_migrate_from_legacy_config` | Migrate server to new backup system |
| GET | `/fetch_pkgacct_master_log` | Return start_background_pkgacct session log file |
| GET | `/get_pkgacct_session_state` | Return start_background_pkgacct session state |
| GET | `/get_users_and_domains_with_backup_metadata` | Return users and domains with backup metadata |
| GET | `/get_users_with_backup_metadata` | Return users with backup metadata |
| GET | `/list_cparchive_files` | Return cparchive files list |
| GET | `/start_background_pkgacct` | Back up an account using the pkgacct script |
| GET | `/start_local_cpmove_restore` | Restore one cPanel account from a backup |
| GET | `/toggle_user_backup_state` | Enable or disable legacy backups |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/cpanel/refs/heads/main/openapi/cpanel-backups-api-openapi.yml
- **Documentation** — https://api.docs.cpanel.net/cpanel/introduction/
- **APIReference** — https://api.docs.cpanel.net/specifications/cpanel.openapi
- **Authentication** — https://api.docs.cpanel.net/cpanel/tokens/
- **Documentation** — https://api.docs.cpanel.net/whm/introduction/
- **APIReference** — https://api.docs.cpanel.net/specifications/whm.openapi
- **Authentication** — https://api.docs.cpanel.net/whm/tokens/

## Other cPanel APIs (12)

- [cPanel API 2 (Legacy)](https://apis.io/apis/cpanel/cpanel-api-2/)
- [Manage2 API](https://apis.io/apis/cpanel/manage2/)
- [cPanel 360 Monitoring API](https://apis.io/apis/cpanel/cpanel-360-monitoring-api/)
- [cPanel Account Creation API](https://apis.io/apis/cpanel/cpanel-account-creation-api/)
- [cPanel Account Enhancements API](https://apis.io/apis/cpanel/cpanel-account-enhancements-api/)
- [cPanel Account Management API](https://apis.io/apis/cpanel/cpanel-account-management-api/)
- [cPanel Account Restoration API](https://apis.io/apis/cpanel/cpanel-account-restoration-api/)
- [cPanel Accounts API](https://apis.io/apis/cpanel/cpanel-accounts-api/)
- [cPanel Addon Domain API](https://apis.io/apis/cpanel/cpanel-addondomain-api/)
- [cPanel API Execution API](https://apis.io/apis/cpanel/cpanel-api-execution-api/)
- [cPanel Applications API](https://apis.io/apis/cpanel/cpanel-applications-api/)
- [cPanel Authentication API](https://apis.io/apis/cpanel/cpanel-authentication-api/)

## Tags

Backups

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/cpanel/cpanel-backups-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/cpanel/.