Description

This function changes a Web Disk account's password

Examples 




https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=WebDisk&cpanel_jsonapi_func=passwdwebdisk&login=user%40example.com&password=12345luggage&enabledigest=1



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Change the password for "user@example.com" to "12345luggage"
$change_password = $cpanel->api2(
    'WebDisk', 'passwdwebdisk',
 array(
        'login' => 'user@example.com',
        'password' => '12345luggage',
        'enabledigest' => '1',
  ) 
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Change the password for "user@example.com" to "12345luggage"
my $change_password = $cpliveapi->api2(
    'WebDisk', 'passwdwebdisk',
{ 
        'login' => 'user@example.com',
        'password' => '12345luggage',
        'enabledigest' => '1',
   }
);

 




cpapi2 --user=username WebDisk passwdwebdisk enabledigest=1 login=user%40example.com password=12345luggage



{
  "cpanelresult": {
    "apiversion": 2,
    "func": "passwdwebdisk",
    "data": [
      {
        "login": "user@example.com"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "WebDisk"
  }
}



Parameters

ParametersTypeDescriptionPossible valuesExample
loginstring

Required

The login name.

The full username, which includes the at symbol (@) and the domain name.user@example.com
passwordstring

Required

The new password.

A secure password.12345luggage
enabledigestBoolean

Whether to enable Digest Authentication.

We introduced this parameter in cPanel & WHM version 11.34.

This parameter defaults to 0.

  • 1 — Enable Digest Authentication.
  • 0 — Disable Digest Authentication.
1

Returns

Return TypeDescriptionPossible valuesExample
loginstringThe login name.The full username, which includes the at symbol (@) and the domain name.user@example.com
reasonstring

A reason for failure.

This function only returns a reason value if it failed.


A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1