WHM API.
Download OpenAPI description
Overview
URL
WebPros International, LLC
License
Languages
Servers
Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/
A server running WHM.
https://{host}:{port}/json-api/
Request
This function lists the server's database users.
Warning:
On most servers, this function returns a large amount of output. We strongly suggest that you filter and sort the output.
Important:
When you disable the MySQL/MariaDB and PostgreSQL roles and remote MySQL is not already configured, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/list_database_users
- A server running WHM.
https://whm-server.tld:2087/json-api/list_database_users
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
whmapi1 --output=jsonpretty \
list_database_usersResponse
application/json
{ "data": { "payload": [ … ] }, "metadata": { "command": "list_database_users", "reason": "OK", "result": 1, "version": 1 } }
Request
This function lists the server's databases.
Warning:
On most servers, this function returns a large amount of output. We strongly suggest that you filter and sort the output.
Important:
When you disable the MySQL/MariaDB and PostgreSQL roles and remote MySQL is not already configured, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/list_databases
- A server running WHM.
https://whm-server.tld:2087/json-api/list_databases
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
whmapi1 --output=jsonpretty \
list_databasesResponse
application/json
{ "data": { "payload": [ … ] }, "metadata": { "command": "list_databases", "reason": "OK", "result": 1, "version": 1 } }
Request
This function retrieves the MySQL® database and user data for the specified account.
Important:
When you disable the MySQL/MariaDB role and remote MySQL is not already configured, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/list_mysql_databases_and_users
- A server running WHM.
https://whm-server.tld:2087/json-api/list_mysql_databases_and_users
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
whmapi1 --output=jsonpretty \
list_mysql_databases_and_users \
user='username'Response
application/json
{ "data": { "mysql_config": { … }, "mysql_databases": { … } }, "metadata": { "command": "list_mysql_databases_and_users", "reason": "OK", "result": 1, "version": 1 } }