Child pages
  • WHM API 1 Functions - set_digest_auth
Skip to end of metadata
Go to start of metadata

 

Description

This function enables or disables Digest Authentication for an account. Windows Vista®, Windows® 7, and Windows® 8 requires that you enable Digest Authentication support in order to access your Web Disk over a clear text, unencrypted connection.

Note:

If the server has an SSL certificate that a recognized certificate authority signed and you can make an SSL connection over port 2078, you do not need to enable Digest Authentication. 


Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/set_digest_auth?user=username&password=12345luggage&enabledigest=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/set_digest_auth?user=username&password=12345luggage&enabledigest=1
 Command Line
whmapi1 set_digest_auth user=username password=12345luggage enabledigest=1


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
   "metadata":
      {
         "version":1,
         "reason":"Digest Authentication enabled.",
         "result":"1,
         "command":"set_digest_auth"
      }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <reason>Digest Authentication enabled.</reason>
        <result>1</result>
        <command>set_digest_auth</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

   

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The account's username.

The username of a cPanel account on the server.

username
passwordstring

Required

The account's password.

A secure password.

12345luggage

enabledigest

or

digestauth

Boolean

Required

Whether to enable Digest Authentication for the account.

  • 1 — Enable.
  • 0 — Disable.
1

 

Returns

This function only returns metadata.