Child pages
  • cPanel API 2 Functions - PasswdStrength::appstrengths

Versions Compared

Key

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

 

Description

Excerpt

This function lists every application's minimum password strength.

Include Page
LIB:_cPanelAPI2NoEquivalent
LIB:_cPanelAPI2NoEquivalent

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=PasswdStrength&cpanel_jsonapi_func=appstrengths

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink

Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List applications and their minimum required strengthx
$check_strength = $cpanel->api2(
    'PasswdStrength', 'appstrengths'
);

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.
 
# List applications and their minimum required strengthx
my $check_strength = $cpliveapi->api2(
    'PasswdStrength', 'appstrengths'
);

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 PasswdStrength appstrengths

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "appstrengths",
    "data": [
      {
        "app": "htaccess",
        "strength": 0
      }
    ],
    "event": {
      "result": 1
    },
    "module": "PasswdStrength"
  }
}

Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote

   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
appstring

The application's name.

  • htaccess
  • passwd
  • ftp — We removed this option in cPanel & WHM version 54.

  • createacct
  • bandmin
  • cpaddons
  • pop — We removed this option in cPanel & WHM version 54.

  • sshkey
  • postgres
  • webdisk — We removed this option in cPanel & WHM version 54.

  • mysql
  • virtual — We introduced this option in cPanel & WHM version 54.

htaccess
strengthinteger

The application's minimum required password strength.

An integer between 0 and 100.0
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