UAPI Functions - Mysql::delete_database

Description

This function deletes a MySQL® database.

Examples 


 cPanel or Webmail Session URL

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

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// Delete the example database.
$delete_db $cpanel->uapi(
    'Mysql''delete_database',
    array(
        'name'       => 'example',
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Delete the example database.
my $delete_db $cpliveapi->uapi(
    'Mysql''delete_database',
    {
        'name'       => 'example',
    }
);

 cPanel Template Toolkit

<!-- Delete the example database. -->
[% execute('Mysql', 'delete_database', { name => 'example' } ) %]

 Command Line

uapi --user=username Mysql delete_database name=example

 

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 database's name. 

 A MySQL database on the cPanel account. 

example

 

Returns

This function only returns metadata.

  • 9 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....