UAPI Functions - Mysql::create_user - Knowledgebase

Description

This function creates a MySQL® database user.

Examples

cPanel or Webmail Session URL

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

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Create a new database user.
$create_db_user = $cpanel->uapi(
    'Mysql', 'create_user',
    array(
        'name'       => 'dbuser',
        'password'   => '12345luggage',
    )
);

 LiveAPI Perl Module

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

cPanel Template Toolkit

[% execute( 'Mysql', 'create_user', { name => 'dbuser', password => '12345luggage' } ) %]

Command Line

uapi --user=username Mysql 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
name	string	Required The new user's name.	A valid database username. Important: To learn more about database username limits, click the database type to expand the following: MySQL MariaDB	dbuser
password	string	Required The new user's password.	A secure password that meets the server's minimum MySQL password strength requirements.	12345luggage

Parameter

Type

Description

Possible values

Example

name

string

Required

The new user's name.

A valid database username.

Important:

To learn more about database username limits, click the database type to expand the following:

MySQL

MariaDB

dbuser

password

string

Required

The new user's password.

A secure password that meets the server's minimum MySQL password strength requirements.

12345luggage

Returns

This function only returns metadata.

Knowledgebase

Categories

Categories