cPanel API 2 Functions - Passwd::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 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 instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples


WHM API (JSON)

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


LiveAPI PHP Class

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


LiveAPI Perl Module

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.


cPanel Tag System (deprecated)

Warnings:
  • 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. 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 Passwd set_digest_auth user=example password=luggage12345 enabledigest=1
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": "Passwd"
  }
}
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
user string

Required

The account name.

A valid cPanel account username. username
password string

Required

The account's current password.

A secure password luggage12345
enabledigest Boolean

Required

Whether to enable Digest Authentication on the account.

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

Returns

Return Type Description Possible values Example
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