UAPI Functions - Postgresql::grant_all_privileges - Knowledgebase

Description

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

Examples

cPanel or Webmail Session URL

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

 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',
         )
);

 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',
    }
);

cPanel Template Toolkit

[% data = execute( 'Postgresql', 'grant_all_privileges', { user => 'example_dbuser', database => 'example_database'} ); %]

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.

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
      
  },
  "data": null
}

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
name	string	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
database	string	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

Parameter

Type

Description

Possible values

Example

name

string

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

database

string

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.

Knowledgebase

Categories

Categories