Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function deletes a MySQL® user.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Mysql/delete_user?name=example

Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Delete the example MySQL user.
$delete_user = $cpanel->uapi(
    'Mysql', 'delete_user',
    array(
        'name'       => 'example',
    )
);

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.
 
# Delete the example MySQL user.
my $delete_user = $cpliveapi->uapi(
    'Mysql', 'delete_user',
    {
        'name'       => 'example',
    }
);

Note:

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

 cPanel Template Toolkit
<!-- Delete the example MySQL user. -->
[% execute('Mysql', 'delete_user', { name => 'example' } ) %]

Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username Mysql delete_user name=example

Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "metadata": {
     
  },
  "data": null
}

Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
namestring

Required

The MySQL user's name.

A MySQL user on the cPanel account.

example

Returns

This function only returns metadata.