cPanel API 2 Functions - WebDisk::passwdwebdisk
Warning:
The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.
Description
This function changes a Web Disk account's password.
Warning:
We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.
Important:
When you disable the Web Disk role, the system disables this function.
Examples
WHM API (JSON)
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=1Note:
For more information, read our Calls from the WHM API documentation.
LiveAPI PHP Class
$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',
)
);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.
# Change the password for "user@example.com" to "12345luggage"
my $change_password = $cpliveapi->api2(
'WebDisk', 'passwdwebdisk',
{
'login' => 'user@example.com',
'password' => '12345luggage',
'enabledigest' => '1',
}
);Note:
For more information, read our Guide to the LiveAPI System.
cPanel Tag System (deprecated)
Warning:
- cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI .
- cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
- For more information, read our Deprecated cPanel Tag Usage documentation.
Command Line
cpapi2 --user=username WebDisk passwdwebdisk enabledigest=1 login=user%40example.com password=12345luggage