cPanel API 1 Functions - Postgres::adduser - Knowledgebase

Description

This function adds a PostgreSQL® database user.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

UAPI (recommended) — Postgresql::create_user — This function creates a PostgreSQL® database user.
cPanel API 2 — None.

Examples

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

$add_postgresuser = $cpanel->api1('Postgres','adduser', array('cpusername_dbusername','12345luggage') ); // Call the function.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

my $add_postgresuser = $cpliveapi->api1('Postgres','adduser', ['cpusername_dbusername','12345luggage'] ); # Call the function.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Postgres::adduser( $FORM('user','password'))">

Output (none)

This function does not return output.

Parameters

Parameter	Type	Description	Possible values	Example
user	string	Required The database's name.	The cPanel username, an underscore (_), and the database user's name. Warning: The maximum length of the username is 63 bytes. If the total length of the parameter exceeds the limit for database usernames, the function will fail.	cpusername_dbusername
password	string	Required The new database user's password.	A secure password.	12345luggage

Parameter

Type

Description

Possible values

Example

user

string

Required

The database's name.

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

Warning:

The maximum length of the username is 63 bytes.
If the total length of the parameter exceeds the limit for database usernames, the function will fail.

cpusername_dbusername

password

string

Required

The new database user's password.

A secure password.

12345luggage

Returns

This function does not return output.

Knowledgebase

Categories

Categories