Child pages
  • UAPI Functions - WebDisk::delete_user
Skip to end of metadata
Go to start of metadata

Description

This function deletes a Web Disk account.

Important:

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

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/WebDisk/delete_user?user=example1%40example.com&destroy=1


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 example1 Web Disk user.
$new_password = $cpanel->uapi(
    'WebDisk', 'delete_user',
    array(
        'user' 	   		=> 'example1@example.com',
		'destroy'		=> '1"
         )
);


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 example1 Web Disk user.
my $set_password = $cpliveapi->uapi(
    'WebDisk', 'delete_user',
    {
        'user'  		=>	'example1@example.com',
		'destroy'		=>	'1'
    }
);


Note:

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

 

 cPanel Template Toolkit
<!-- Delete the example1 Web Disk user. -->
[% execute( 'WebDisk', 'delete_user', { user => 'example1@example.com', destroy => '1' } ); %]


Note:

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

 

 Command Line
uapi --user=username WebDisk delete_user user=example1%40example.com destroy=1


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. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 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
userstring

Required

The Web Disk account username.

The username of a Web Disk account on the cPanel account.

example1@example.com
destroyBoolean

Required

Whether to delete the WebDisk account.

  • 1 — Confirm deletion of the WebDisk account.
  • 0 — Do not delete the WebDisk account.
1

Returns

This function only returns metadata.