Description
This function changes the Web Disk account's password.
Examples
cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/WebDisk/set_password?user=example1%40example.com&password=12345luggage&enabledigest=0
LiveAPI PHP Class
$cpanel = new CPANEL();
$new_password = $cpanel->uapi(
'WebDisk', 'set_password',
array(
'user' => 'example1@example.com',
'password' => '12345luggage",
'enabledigest => '0',
)
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $set_password = $cpliveapi->uapi(
'WebDisk', 'set_password',
{
'user' => 'example1@example.com',
'password' => '12345luggage',
'enabledigest' => '0'
}
);
cPanel Template Toolkit
[% execute( 'WebDisk', 'set_password', { user => 'example1@example.com', password => '12345luggage', enabledigest => '0' } ); %]
Command Line
uapi --user=username WebDisk set_password user=example1%40example.com password=12345luggage enabledigest=0
|
Output (JSON)
{
"messages":null,
"errors":null,
"status":1,
"metadata":{
},
"data":null
}
Parameters
|
Parameter
|
Type
|
Description
|
Possible values
|
Example
|
|
user
|
string
|
Required
The Web Disk account username.
|
The username of a Web Disk account on the cPanel account.
|
example1@example.com
|
|
password
|
string
|
Required
The Web Disk account's password.
|
A secure password.
|
12345luggage
|
|
enabledigest
|
Boolean
|
Whether to enable Digest Authentication.
|
- 1 — Enable Digest Authentication.
- 0 — Disable Digest Authentication.
|
0
|
Returns
This function only returns metadata.
