Child pages
  • cPanel API 2 Functions - WebDisk::set_digest_auth

Versions Compared

Key

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

Description

Excerpt

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

Include Page
LIB:_cPanelAPI2NoEquivalent
LIB:_cPanelAPI2NoEquivalent

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledWebDiskRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleWHM API (JSON)


Code Block
languagetext
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

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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',
  ) 
 );

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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',
  }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning


Expand
titleCommand Line


Code Block
languagebash
cpapi2 --user=username WebDisk set_digest_auth enabledigest=1 login=user%40example.com password=12345luggage

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


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


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

Parameter TypeDescriptionPossible valuesExample
loginstring

Required

The account's full username.

The full username, which includes the at symbol (@) and the domain name.user@example.com
passwordstring

Required

The account's password.

A valid password.

12345luggage
enabledigestBoolean

Required

Whether to enable Digest Authentication on the Web Disk account.

  • 1 — Digest Authentication enabled.
  • 0 — Digest Authentication disabled
1

Returns

Return TypeDescriptionPossible valuesExample
reasonstringWhether Digest Authentication is enabled on the account.
  • Digest Authentication enabled.
  • Digest Authentication disabled.
Digest Authentication enabled
reasonstring

A reason for failure.

Note
titleNote:

This function only returns a reason value if it failed.


A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1