Child pages
  • cPanel API 1 Functions - Postgres::deluserdb
Skip to end of metadata
Go to start of metadata

 

Description

This function removes a PostgreSQL® database user's access to a database.

Warning:

cPanel API 1 is deprecated. We strongly recommend that you do not use cPanel API 1. However, no equivalent function exists in our newer APIs.

Examples


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$remove_postgresuser = $cpanel->api1('Postgres','deluserdb', array('cpusername_dbname','cpusername_dbusername') ); // Call the function.


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $remove_postgresuser = $cpliveapi->api1('Postgres','deluserdb', ['cpusername_dbname','cpusername_dbusername'] ); # Call the function.


Note:

For more information, read our Guide to the LiveAPI System.

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Postgres::deluserdb( $FORM('db','user'))">
 Command Line
cpapi1 --user=username Postgres deluserdb cpusername_dbname cpusername_dbusername


Notes:

  • You must URI-encode these values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi1 command:

    /usr/local/cpanel/bin/cpapi1

 Output (none)
This function does not return output.

Parameters

ParameterTypeDescriptionPossible valuesExample
dbstring

Required

The database name.

The cPanel username, an underscore (_), and the database's name.

cpusername_dbname
userstring

Required

The database user.

The cPanel username, an underscore (_), and the database user's name.

cpusername_dbusername

Returns

This function does not return output.