Child pages
  • WHM API 1 Functions - get_password_strength
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

 

Description

This function measures the strength of a password.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/get_password_strength?api.version=1&password=12345luggage
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/get_password_strength?api.version=1&password=12345luggage
 Command Line
whmapi1 get_password_strength password=12345luggage


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
  "data": {
    "strength": 21
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "get_password_strength"
  }
}
 Output (XML)
<result>
    <data>
        <strength>21</strength>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>get_password_strength</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

   

Parameters

ParameterTypeDescriptionPossible valuesExample
passwordstring

Required

The password.

A valid string.

12345luggage

Returns

ReturnTypeDescriptionPossible valuesExample
strengthinteger

The password's strength.

A positive integer from 1 to 100.21

 

 

  • No labels