Child pages
  • cPanel API 2 Functions - MysqlFE::createdbuser
Skip to end of metadata
Go to start of metadata

Description

This function creates a database user.

Warning:

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

Important:

In cPanel & WHM version 76 and later, when you disable the MySQL role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

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


Note:

 For more information, read our Calls from the WHM API documentation.

 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',
 ) 
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 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',
    }
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Tag System (deprecated)


Warnings:

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

 Command Line
cpapi2 --user=username MysqlFE createdbuser dbuser=example_user1 password=12345luggage


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:

    /usr/local/cpanel/bin/cpapi2

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


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
dbuserstring

Required

The database username.

Notes:

  • 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 the desired database type:

 MySQL

MySQL limits the database username to 16 characters. The system includes the database prefix (the first eight characters of the cPanel account's username and an underscore character) in the character count for the username.

For example:

  • A MySQL database with the db_ prefix allows usernames up to 13 characters long.
  • A MySQL database with the example_ prefix allows usernames up to eight characters long.
 MariaDB

MariaDB limits the database username to 47 characters. The system includes the database prefix (all of the cPanel account's username and an underscore character) in the character count for the username.

For example:

  • A MariaDB database with the db_ prefix allows usernames up to 44 characters long.
  • A MariaDB database with the example_ prefix allows usernames up to 39 characters long.

example_user1
passwordstring

Required

The new password.

A valid password.12345luggage

Returns

ReturnTypeDescriptionPossible valuesExample
reasonstring

A reason for failure.

Note:

This function only returns a reason value if it failed.

A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

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