UAPI Functions - Postgresql::create_user

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(); // Connect to cPanel - only do this once.
  
// Create the PostgreSQL database user "dbuser" with the password "12345luggage"
$create_user $cpanel->uapi(
    'Postgresql''create_user',
    array(
        'user'    => 'dbuser',
        'password'=> '12345luggage',
         )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
#  Create the PostgreSQL database user "dbuser" with the password "12345luggage"
my $create_user $cpliveapi->uapi(
    'Postgresql''create_user',
    {
        'name'    => 'dbuser',
        'password'=> '12345luggage',
    }
);

 cPanel Template Toolkit

<!--  Create the PostgreSQL database user "dbuser" with the password "12345luggage" -->
[% data = execute( 'Postgresql', 'create_user', { name => 'database', password => '12345luggage'} ); %]

 Command Line

uapi --user=username Postgresql create_user name=dbuser password=12345luggage

 

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

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.

  • 8 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....