Return minimum password strength

This function retrieves the minimum password strength for cPanel & WHM accounts.

Authorizations:
query Parameters
name
string

The service for which to display the minimum password value. If you do not use this parameter, this function returns the minimum password setting for all values.

  • default - All services
  • cpaddons - cPAddons
  • createacct - New cPanel accounts
  • list - Mailing lists
  • mysql - MySQL® database users
  • passwd - WHM user or system accounts
  • postgres - PostgreSQL database users
  • sshkey - SSH keys
  • virtual - Mail, FTP, Web Disk, and WebDAV accounts
Enum: "default" "cpaddons" "createacct" "list" "mysql" "passwd" "postgres" "sshkey" "virtual"
Example: name=default

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  getminimumpasswordstrengths

Response samples

Content type
application/json
{
  • "data": {
    • "cpaddons": 50,
    • "createacct": 50,
    • "default": 50,
    • "list": 50,
    • "mysql": 50,
    • "passwd": 50,
    • "postgres": 50,
    • "sshkey": 50,
    • "virtual": 50
    },
  • "metadata": {
    • "command": "getminimumpasswordstrengths",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}