# cPanel API 2 Functions - Passwd::set_digest_auth

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

This function manages Digest Authentication on a cPanel account.

Windows Vista®, Windows® 7, and Windows® 8 require that you enable Digest Authentication support in order to access your Web Disk over a
clear text, unencrypted connection. If the server has an SSL certificate signed by a recognized certificate authority and you are able to make an
SSL connection over port `2078`, you do not need to enable this.

Warning:
We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists.

## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Passwd&cpanel_jsonapi_func=set_digest_auth&enabledigest=1&password=luggage12345&user=example
```

Note:
For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


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

// Enable digest authentication on the "example" account
$digest_auth = $cpanel->api2(
    'Passwd', 'set_digest_auth',
    array(
        'user' => 'example',
        'password' => 'luggage12345',
        'enabledigest' => '1',
    )
);
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


```undefined syntaxhighlighter-pre
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Enable digest authentication on the "example" account
my $digest_auth = $cpliveapi->api2(
    'Passwd', 'set_digest_auth',
    {
        'user' => 'example',
        'password' => 'luggage12345',
        'enabledigest' => '1',
    }
);
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system).
- 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username Passwd set_digest_auth user=example password=luggage12345 enabledigest=1
```

div
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](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "set_digest_auth",
    "data": [
      {
        "reason": "Digest Authentication enabled.",
        "result": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Passwd"
  }
}
```

Note:
Use cPanel's *[API Shell](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

table
colgroup
col
col
col
col
col
thead
tr
th
strong
Parameter
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
user
td
em
string
td
p
strong
Required
p
The account name.
td
A valid cPanel account username.
td
code
username
tr
td
code
password
td
em
string
td
p
strong
Required
p
The account's current password.
td
A secure password
td
code
luggage12345
tr
td
code
enabledigest
td
em
Boolean
td
p
strong
Required
p
Whether to enable Digest Authentication on the account.
td
ul
li
code
1
 — Enable Digest Authentication.
li
code
0
 — Disable Digest Authentication.
td
code
1
## Returns

table
thead
tr
th
Return
th
Type
th
Description
th
Possible values
th
Example
tbody
tr
td
code
reason
td
em
string
td
div
p
A reason for failure.
p
This function only returns a 
code
reason
 value if it failed.
td
p
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1