You can find our user documentation at docs.cpanel.net.

Check out our new API beta site!

Child pages
  • UAPI Functions - Postgresql::grant_all_privileges
Skip to end of metadata
Go to start of metadata

Description

This function grants all privileges for a PostgreSQL® database to a database user.

Important:

In cPanel & WHM version 76 and later, when you disable the PostgreSQL role, the system disables this function.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Postgresql/grant_all_privileges?user=example_dbuser&database=example_database


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Grants all privileges for PostgreSQL database "example_database" to database user "example_dbuser"
$grant_all = $cpanel->uapi(
    'Postgresql', 'grant_all_privileges',
    array(
        'user'    => 'example_dbuser',
        'database'=> 'example_database',
         )
);


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.
 
# Grants all privileges for PostgreSQL database "example_database" to database user "example_dbuser"
my $grant_all = $cpliveapi->uapi(
    'Postgresql', 'grant_all_privileges',
    {
        'user'    => 'example_dbuser',
        'database'=> 'example_database',
    }
);


Note:

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


 Command Line
uapi --user=username Postgresql grant_all_privileges user=example_dbuser database=example_database


Notes:

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

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
     
  },
  "data": null
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The database user's name.

A valid string.

Note:

If database prefixing is enabled, this value must include the database prefix for the account.

example_dbuser
databasestring

Required

The database's name.

A valid string.

Note:

If database prefixing is enabled, this value must include the database prefix for the account.

example_database

Returns

This function only returns metadata.