Child pages
  • WHM API 1 Functions - set_digest_auth

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

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
titleNote:

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. 


Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/set_digest_auth?user=username&password=12345luggage&enabledigest=1
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/set_digest_auth?user=username&password=12345luggage&enabledigest=1
Expand
titleCommand Line
Code Block
languagebash
whmapi1 set_digest_auth user=username password=12345luggage enabledigest=1

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
   "metadata":
      {
         "version":1,
         "reason":"Digest Authentication enabled.",
         "result":"1,
         "command":"set_digest_auth"
      }
}
Expand
titleOutput (XML)
Code Block
languagetext
linenumberstrue
<result>
    <metadata>
        <version>1</version>
        <reason>Digest Authentication enabled.</reason>
        <result>1</result>
        <command>set_digest_auth</command>
    </metadata>
</result>

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

   

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.