cPanel API 2 Functions - MysqlFE::createdbuser - Knowledgebase

Description

This function creates a database user.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

Mysql::create_user — This function creates a MySQL® database user.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=MysqlFE&cpanel_jsonapi_func=createdbuser&dbuser=example_user1&password=12345luggage

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Creates the database user "example_user1"
$create_user = $cpanel->api2(
    'MysqlFE', 'createdbuser', 
    array(
        'dbuser'   => 'example_user1',
        'password' => '12345luggage',
 ) 
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Creates the database user "example_user1"
my $create_user = $cpliveapi->api2(
    'MysqlFE', 'createdbuser',
    {
        'dbuser'   => 'example_user1',
        'password' => '12345luggage',
    }
);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 Output (JSON)

 {
  "cpanelresult": {
    "apiversion": 2,
    "data": [
      1
    ],
    "func": "createdbuser",
    "event": {
      "result": 1
    },
    "module": "MysqlFE"
  }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
dbuser	string	Required The database username. Note: You cannot create a database username that already exists. Whether database prefixing is enabled limits the maximum number of available database characters. You can enable or disable database prefixing via the database_prefix key in The cpanel.config File.	A valid username. Important: To learn more about database username limits, click your database type to expand the following: MySQL MariaDB	example_user1
password	string	Required The new password.	A valid password.	12345luggage

Parameter

Type

Description

Possible values

Example

dbuser

string

Required

The database username.

Note:

You cannot create a database username that already exists.
Whether database prefixing is enabled limits the maximum number of available database characters. You can enable or disable database prefixing via the database_prefix key in The cpanel.config File.

A valid username.

Important:

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

MySQL

MariaDB

example_user1

password

string

Required

The new password.

A valid password.

12345luggage

Returns

Return	Type	Description	Possible values	Example
reason	string	A reason for failure. Note: This function only returns a reasonvalue if it failed.	A string that describes the error.	This is an error message.
result	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Return

Type

Description

Possible values

Example

reason

string

A reason for failure.

Note:

This function only returns a reasonvalue if it failed.

A string that describes the error.

This is an error message.

result

boolean

Whether the function succeeded.

1 — The function succeeded.
0 — The function failed.

Knowledgebase

Categories

Categories