- Created by Documentation, last modified on Oct 05, 2018
disable_authentication_provider
disable_failing_authentication_providers
enable_authentication_provider
get_available_authentication_providers
get_provider_client_configurations
get_provider_configuration_fields
get_provider_display_configurations
get_users_authn_linked_accounts
set_provider_client_configurations
set_provider_display_configurations
twofactorauth_generate_tfa_config
twofactorauth_get_user_configs
cpgreylist_is_server_netblock_trusted
cpgreylist_list_entries_for_common_mail_provider
cpgreylist_load_common_mail_providers_config
cpgreylist_save_common_mail_providers_config
cpgreylist_trust_entries_for_common_mail_provider
cpgreylist_untrust_entries_for_common_mail_provider
create_cpgreylist_trusted_host
delete_cpgreylist_trusted_host
Description
This function lists the server's databases.
Warning:
Important:
MySQL
and Postgres
roles, the system disables this function. For more information, read our How to Use Server Profiles documentation.Examples
https://hostname.example.com:2087/cpsess##########/json-api/list_databases?api.version=1
https://hostname.example.com:2087/cpsess##########/xml-api/list_databases?api.version=1
whmapi1 list_databases
Notes:
- You must URI-encode values.
- For more information and additional output options, read our Guide to WHM API 1 documentation or run the
whmapi1 --help
command. If you run CloudLinux™, you must use the full path of the
whmapi1
command:/usr/local/cpanel/bin/whmapi1
{ "data": { "payload": [ { "engine": "postgresql", "name": "example_db0", "cpuser": "example" }, { "engine": "postgresql", "name": "example_db1", "cpuser": "example" }, ] }, "metadata": { "version": 1, "reason": "OK", "result": "1", "command": "list_databases" } }
<result> <data> <payload> <engine>postgresql</engine> <name>example_db0</name> <cpuser>example</cpuser> </payload> <payload> <engine>postgresql</engine> <name>example_db1</name> <cpuser>example</cpuser> </payload> </data> <metadata> <version>1</version> <reason>OK</reason> <result>1</result> <command>list_databases</command> </metadata> </result>
Note:
Parameters
This function does not accept parameters.
Returns
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
payload | array of hashes | An array of hashes of database data. | This hash includes the engine , name , and cpuser returns. | |
| string | The database's engine. The function returns this value in the |
| postgresql |
| string | The database's name. The function returns this value in the | A valid database name. | example_db0 |
| string | The database's owner. The function returns this value in the | A valid username. | example |
Function information
API Version:
Available in:
WHM 11.44+
Methods:
GET, POST
Required Parameters:
(none)
Return Formats:
About WHM API 1
WHM API 1 performs functions and accesses data in WHM.
Notes:
- Some functions and parameters may require that you authenticate as the
root
user. - You must use the appropriate WHM ports (
2086
or2087
) to call WHM API functions.
Find a function
Related functions
-
Page:WHM API 1 Sections - Databases — Database functions allow you to manage your MySQL® and PostgreSQL® database settings.
-
Page:WHM API 1 Functions - rename_mysql_database — This function changes a MySQL® database's name.
-
Page:WHM API 1 Functions - rename_mysql_user — This function changes a MySQL® database user's name.
-
Page:WHM API 1 Functions - set_mysql_password — This function changes a MySQL® database user's password.
-
Page:WHM API 1 Functions - installable_mysql_versions — This function lists all available versions of MySQL® and MariaDB.