Child pages
  • UAPI Functions - WebDisk::delete_user

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt
This function deletes a Web Disk account.


Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titlecPanel or Webmail Session URL


Code Block
languagetext
https://hostname.example.com:2083/cpsess##########/execute/WebDisk/delete_user?user=example1%40example.com&destroy=1

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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"
         )
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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'
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Template Toolkit


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

Include Page
LIB:_TTLink
LIB:_TTLink

 


Expand
titleCommand Line


Code Block
uapi --user=username WebDisk delete_user user=example1%40example.com destroy=1

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  

   },
   "data":null
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


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.