Description
This function creates a PostgreSQL® database user.
Examples
cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Postgresql/create_user?name=dbuser&password=12345luggage
LiveAPI PHP Class
$cpanel = new CPANEL();
$create_user = $cpanel->uapi(
'Postgresql', 'create_user',
array(
'user' => 'dbuser',
'password'=> '12345luggage',
)
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $create_user = $cpliveapi->uapi(
'Postgresql', 'create_user',
{
'name' => 'dbuser',
'password'=> '12345luggage',
}
);
cPanel Template Toolkit
[% data = execute( 'Postgresql', 'create_user', { name => 'database', password => '12345luggage'} ); %]
Command Line
uapi --user=username Postgresql create_user name=dbuser password=12345luggage
|
Output (JSON)
{
"messages": null,
"errors": null,
"status": 1,
"metadata": {
},
"data": null
}
Parameters
|
Parameter
|
Type
|
Description
|
Possible values
|
Example
|
|
password
|
string
|
Required
The new user's password.
|
A secure password.
|
12345luggage
|
|
name
|
string
|
Required
The database user's name.
|
A valid string.
Note:
If database prefixing is enabled, this parameter must include the database prefix for the account.
|
dbuser
|
Returns
This function only returns metadata.
