Page tree

Versions Compared

Key

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

 

Description

Excerpt

This function sets the minimum password strength for user accounts.

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/setminimumpasswordstrengths?api.version=1&passwd=50
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/setminimumpasswordstrengths?api.version=1&passwd=50
Expand
titleCommand Line
Code Block
languagebash
whmapi1 setminimumpasswordstrengths passwd=50

Include Page
_WHMAPI1CLINote
_WHMAPI1CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "metadata": {
    "reason": "OK",
    "result": 1,
    "version": 1,
    "command": "setminimumpasswordstrengths"
  }  
}
Expand
titleOutput (XML)
Code Block
languagetext
linenumberstrue
<result>
    <metadata>
        <reason>OK</reason>
        <result>1</result>
        <version>1</version>
        <command>setminimumpasswordstrengths</command>
    </metadata>
</result>

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

Parameters

Note
titleNote:

If you do not specify a value, the system will retain the existing setting.

ParameterTypeDescriptionPossible valuesExample
defaultinteger

The minimum password strength for all services.

A positive integer from 1 to 100 that measures the relative strength of the password. 50
bandmininteger

The minimum password strength for Bandmin.

Note
titleNote:

We removed this parameter in cPanel & WHM version 58.

A positive integer from 1 to 100 that measures the relative strength of the password. 50
cpaddonsintegerThe minimum password strength for cpAddons.A positive integer from 1 to 100 that measures the relative strength of the password. 50
createacctintegerThe minimum password strength for new cPanel accounts.A positive integer from 1 to 100 that measures the relative strength of the password. 50
ftpinteger

The minimum password strength for FTP accounts.

Note
titleNote:

We removed this parameter in cPanel & WHM version 54.

A positive integer from 1 to 100 that measures the relative strength of the password.

 

50
listintegerThe minimum password strength for mailing lists.A positive integer from 1 to 100 that measures the relative strength of the password. 50
mysqlintegerThe minimum password strength for MySQL® database users.A positive integer from 1 to 100 that measures the relative strength of the password. 50
passwdintegerThe minimum password strength for cPanel (system) accounts.A positive integer from 1 to 100 that measures the relative strength of the password. 50
popinteger

The minimum password strength for mail accounts.

Note
titleNote:

We removed this parameter in cPanel & WHM version 54.

A positive integer from 1 to 100 that measures the relative strength of the password.

 

50
postgresintegerThe minimum password strength for PostgreSQL database users.A positive integer from 1 to 100 that measures the relative strength of the password. 50
sshkeyintegerThe minimum password strength for SSH keys.A positive integer from 1 to 100 that measures the relative strength of the password. 50
webdiskinteger

The minimum password strength for Web Disk (WebDAV) accounts.

Note
titleNote:

We removed this parameter in cPanel & WHM version 54.

A positive integer from 1 to 100 that measures the relative strength of the password.

 

50
virtualinteger

The minimum password strength for mail, FTP, Web Disk, and WebDAV accounts.

Note
titleNote:

We added this parameter in cPanel & WHM version 54.

A positive integer from 1 to 100 that measures the relative strength of the password.

50

Returns

This function only returns metadata.