# cPanel Databases API

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

cPanel Databases 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 Database. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

The Databases module for WHM API 1.

## Operations (27)

| Method | Path | Summary |
|---|---|---|
| GET | `/background_mysql_upgrade_checker_run` | Validate MySQL status before upgrade |
| GET | `/background_mysql_upgrade_status` | Return MySQL or MariaDB upgrade status |
| GET | `/current_mysql_version` | Return MySQL version |
| GET | `/get_database_optimizations` | Return MySQL database optimizations |
| GET | `/installable_mysql_versions` | Return available MySQL versions |
| GET | `/latest_available_mysql_version` | Return latest MySQL version |
| GET | `/list_database_users` | Return MySQL users |
| GET | `/list_databases` | Return MySQL databases |
| GET | `/list_mysql_databases_and_users` | Return MySQL databases and users for account |
| GET | `/remote_mysql_create_profile` | Create remote MySQL profile |
| GET | `/remote_mysql_create_profile_via_ssh` | Create remote MySQL profile via SSH |
| GET | `/remote_mysql_delete_profile` | Delete remote MySQL profile |
| GET | `/remote_mysql_initiate_profile_activation` | Start remote MySQL profile activation |
| GET | `/remote_mysql_monitor_profile_activation` | Return remote MySQL profile activation |
| GET | `/remote_mysql_read_profile` | Return remote MySQL profile |
| GET | `/remote_mysql_read_profiles` | Return remote MySQL profiles |
| GET | `/remote_mysql_update_profile` | Update remote MySQL profile |
| GET | `/remote_mysql_validate_profile` | Validate remote MySQL profile connection |
| GET | `/rename_mysql_database` | Update MySQL database name |
| GET | `/rename_mysql_user` | Update MySQL username |
| GET | `/rename_postgresql_database` | Update PostgreSQL database name |
| GET | `/rename_postgresql_user` | Update PostgreSQL username |
| GET | `/set_local_mysql_root_password` | Update MySQL root password |
| GET | `/set_mysql_password` | Update MySQL user password |
| GET | `/set_postgresql_password` | Update PostgreSQL user password |
| GET | `/start_background_mysql_upgrade` | Start background MySQL upgrade |
| POST | `/update_sql_config` | Update the servers SQL configuration |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/cpanel/refs/heads/main/openapi/cpanel-databases-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

Database

---

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