- 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 changes a PostgreSQL® database's name.
Warning:
The system requires more time to rename larger and more complex databases.
Important:
Postgres
role, 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/rename_postgresql_database?api.version=1&oldname=database&newname=database2&cpuser=example
https://hostname.example.com:2087/cpsess##########/xml-api/rename_postgresql_database?api.version=1&oldname=database&newname=database2&cpuser=example
whmapi1 rename_postgresql_database oldname=database newname=database2 cpuser=example
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
{ "metadata": { "version": 1, "reason": "OK", "result": "1", "command": "rename_postgresql_database" } }
<result> <metadata> <version>1</version> <reason>OK</reason> <result>1</result> <command>rename_postgresql_database</command> </metadata> </result>
Note:
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
oldname | string | Required The database's current name. | A valid database name. | database |
| string | Required The database's new name. | A valid database name. Warning: If database prefixing is enabled, this parameter must include the database prefix for the account. | database2 |
| string | The database's owner. | A valid username. | username |
Returns
This function only returns metadata.
Function information
API Version:
Available in:
WHM 11.44+
Methods:
GET, POST
Required Parameters:
oldname
, newname
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_postgresql_database — This function changes a PostgreSQL® database's name.
-
Page:WHM API 1 Functions - rename_postgresql_user — This function changes a PostgreSQL® database user's name.