Description
This function manages a Web Disk account's Digest Authentication status.
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=set_digest_auth&login=user%40example.com&password=12345luggage&enabledigest=1
LiveAPI PHP Class
$cpanel = new CPANEL();
$set_da = $cpanel->api2(
'WebDisk', 'set_digest_auth',
array(
'login' => 'user@example.com',
'password' => '12345luggage',
'enabledigest' => '1',
)
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $set_da = $cpliveapi->api2(
'WebDisk', 'set_digest_auth',
{
'login' => 'user@example.com',
'password' => '12345luggage',
'enabledigest' => '1',
}
);
cPanel Tag System (deprecated)
Warning:
In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.
cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read ourDeprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
Command Line
cpapi2 --user=username WebDisk set_digest_auth enabledigest=1 login=user%40example.com password=12345luggage
|
Output (JSON)
{
"cpanelresult": {
"apiversion": 2,
"func": "set_digest_auth",
"data": [
{
"reason": "Digest Authentication enabled.",
"result": 1
}
],
"event": {
"result": 1
},
"module": "WebDisk"
}
}
Parameters
|
Parameter
|
Type
|
Description
|
Possible values
|
Example
|
|
login
|
string
|
Required
The account's full username.
|
The full username, which includes the at symbol (@) and the domain name.
|
user@example.com
|
|
password
|
string
|
Required
The account's password.
|
A valid password.
|
12345luggage
|
|
enabledigest
|
Boolean
|
Required
Whether to enable Digest Authentication on the Web Disk account.
|
- 1 — Digest Authentication enabled.
- 0 — Digest Authentication disabled
|
1
|
Returns
|
Return
|
Type
|
Description
|
Possible values
|
Example
|
|
reason
|
string
|
Whether Digest Authentication is enabled on the account.
|
- Digest Authentication enabled.
- Digest Authentication disabled.
|
Digest Authentication enabled
|
|
reason
|
string
|
A reason for failure.
Note:
This function only returns a reason value if it failed.
|
A string that describes the error.
|
This is an error message.
|
|
result
|
Boolean
|
Whether the function succeeded.
|
- 1 — The function succeeded.
- 0 — The function failed.
|
1
|
