Child pages
  • UAPI Functions - Postgresql::create_user

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt
This function creates a PostgreSQL® database user.

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledPostgresRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titlecPanel or Webmail Session URL


Code Block
languagetext
https://hostname.example.com:2083/cpsess##########/execute/Postgresql/create_user?name=dbuser&password=12345luggage

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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',
         )
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Template Toolkit


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

Include Page
LIB:_TTLink
LIB:_TTLink

 


Expand
titleCommand Line


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

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
     
  },
  "data": null
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
name string

Required

The database user's name.

A valid string.

Note
titleNote:

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


dbuser
passwordstring

Required

The new user's password.

A secure password.12345luggage

Returns

This function only returns metadata.