UAPI Functions - Mysql::create_database - Knowledgebase

Description

This function creates a MySQL® database.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Mysql/create_database?name=newdb

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Create a new database.
$create_db = $cpanel->uapi(
    'Mysql', 'create_database',
    array(
        'name'    => 'newdb',
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Create a new database.
my $create_db = $cpliveapi->uapi(
    'Mysql', 'create_database',
    {
        'name'    => 'newdb',
    }
);

cPanel Template Toolkit

[% execute( 'Mysql', 'create_database', { name => 'newdb' } ) %]

Command Line

uapi --user=username Mysql create_database name=newdb

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 database's name.	A valid database name. Important: If database prefixing is enabled, you must prefix this value with the account prefix and an underscore (_). For example, to create the newdb database on the user cPanel account, pass a value of user_newdb.	newdb

Parameter

Type

Description

Possible values

Example

name

string

Required

The new database's name.

A valid database name.

Important:

If database prefixing is enabled, you must prefix this value with the account prefix and an underscore (_).

For example, to create the newdb database on the user cPanel account, pass a value of user_newdb.

newdb

Returns

This function only returns metadata.

Knowledgebase

Categories

Categories