cPanel API 2 Functions - PasswdStrength::get_required_strength - Knowledgebase

Description

The application's required minimum password strength

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

PasswdStrength::get_required_strength — This function retrieves an application's minimum required password strength.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=PasswdStrength&cpanel_jsonapi_func=get_required_strength&app=ftp

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Check the minimum required strength for ftp passwords
$check_strength = $cpanel->api2(
    'PasswdStrength', 'get_required_strength', 
    array(
        'app' => 'ftp',
    ) 
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Check the minimum required strength for ftp passwords
my $check_strength = $cpliveapi->api2(
    'PasswdStrength', 'get_required_strength',
    {
        'app' => 'ftp',
    }
);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use theLiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read ourDeprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

Command Line

cpapi2 --user=username PasswdStrength appstrengths app=ftp

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "get_required_strength",
    "data": [
      {
        "strength": 0
      }
    ],
    "event": {
      "result": 1
    },
    "module": "PasswdStrength"
  }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
app	string	Required The application's name.	htaccess passwd ftp createacct bandmin Note: We removed the bandmin parameter value in cPanel & WHM version 58. cpaddons pop sshkey postgres webdisk mysql	ftp

Parameter

Type

Description

Possible values

Example

app

string

Required

The application's name.

htaccess
passwd
ftp
createacct
bandmin

Note:

We removed the bandmin parameter value in cPanel & WHM version 58.

cpaddons
pop
sshkey
postgres
webdisk
mysql

ftp

Returns

Return	Type	Description	Possible values	Example
strength	integer	The application's required minimum password strength.	An integer between 0 and100.	0
reason	string	A reason for failure. Note: 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

Knowledgebase

Categories

Categories