cPanel API 2 Functions - WebDisk::set_digest_auth

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function manages a Web Disk account's Digest Authentication status.

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=set_digest_auth&login=user%40example.com&password=12345luggage&enabledigest=1

Note:

For more information, read our Calls from the WHM API documentation.

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

//  Set Digest Authentication status for "user@example.com"
$set_da = $cpanel->api2(
    'WebDisk', 'set_digest_auth',
 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.

# Set Digest Authentication status for "user@example.com"
my $set_da = $cpliveapi->api2(
    'WebDisk', 'set_digest_auth',
{
        '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 set_digest_auth enabledigest=1 login=user%40example.com password=12345luggage

Notes:

You must URI-encode values.
username represents your account-level username.
You must include the --user=username option.
For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "set_digest_auth",
    "data": [
      {
        "reason": "Digest Authentication enabled.",
        "result": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "WebDisk"
  }
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter Type Description Possible values Example

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`

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. 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`