Create MySQL user

This function creates a MySQL® database user.

Important:

When you disable the MySQL role and remote MySQL is not already configured, the system disables this function.

SecurityBasicAuth
Request
query Parameters
name
required
string

A valid database username.

Important:

To learn more about database username limits, check your database type:

MySQL 5.6

MySQL version 5.6 limits the database username to 16 characters. The server uses the first nine characters of this limit for the database prefix. The database prefix uses the cPanel account's username and an underscore (_). The server only applies the first eight characters of the cPanel account's username.

For example:

  • A db_ database prefix allows MySQL usernames of up to 13 characters.
  • An example_ database prefix allows MySQL usernames of up to eight characters.

MySQL 5.7+

MySQL versions 5.7 and later limit the database username to 32 characters. The server uses the first nine characters of this limit for the database prefix. The database prefix uses the cPanel account's username and an underscore (_). The server only applies the first eight characters of the cPanel account's username.

For example:

  • A db_ database prefix allows MySQL usernames of up to 29 characters.
  • An example_ database prefix allows MySQL usernames of up to 24 characters.

MariaDB

MariaDB limits the database username to 47 characters. The server uses the first nine characters of this limit for the database prefix. The database prefix uses the cPanel account's username and an underscore (_). The server only applies the first eight characters of the cPanel account's username.

For example:

  • A db_ database prefix allows MariaDB usernames of up to 44 characters.
  • An example_ database prefix allows MariaDB usernames of up to 39 characters.
Example: name=dbuser
password
required
string

The new user's password.

Example: password=12345luggage
prefix-size
integer
Default: 16

The desired prefix size.

Enum: 8 16
Example: prefix-size=16
Responses
200

HTTP Request was successful.

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object
get/Mysql/create_user
Request samples
uapi --output=jsonpretty \
  --user=username \
  Mysql \
  create_user \
  name='dbuser' \
  password='12345luggage'
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "create_user",
  • "module": "Mysql",
  • "result": {
    • "data": null,
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}
©2022 cPanel, L.L.C. All rights reserved.Privacy PolicyTrademarks