cPanel API 2 Functions - PasswdStrength::get_password_strength - Knowledgebase

Description

This function checks a password's strength.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

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_password_strength&password=12345luggage

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Check the strength of a given password
$check_password = $cpanel->api2(
    'PasswdStrength', 'get_password_strength', 
    array(
        'password' => '12345luggage',
    ) 
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Check the strength of a given password
my $check_password = $cpliveapi->api2(
    'PasswdStrength', 'get_password_strength',
    {
        'password' => '12345luggage',
    }
);

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.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "get_password_strength",
    "data": [
      {
        "strength": 54
      }
    ],
    "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
password	string	Required The password to check.	A valid string.	12345luggage

Parameter

Type

Description

Possible values

Example

password

string

Required

The password to check.

A valid string.

12345luggage

Returns

Return	Type	Description	Possible values	Example
strength	integer	The password's 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