Developer Documentation
Child pages
  • WHM API 1 Functions - setminimumpasswordstrengths
Skip to end of metadata
Go to start of metadata

 

Guide to WHM API 1

Return Data

Filter Output

Sort Output

Paginate Output

Output Columns

Call cPanel API 2 and UAPI

 

 

Description

This function sets the minimum password strength for user accounts.

Examples 

 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/setminimumpasswordstrengths?api.version=1&passwd=50
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/setminimumpasswordstrengths?api.version=1&passwd=50
 Command Line
whmapi1 setminimumpasswordstrengths passwd=50


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)
{
  "metadata": {
    "reason": "OK",
    "result": 1,
    "version": 1,
    "command": "setminimumpasswordstrengths"
  }  
}
 Output (XML)
<result>
    <metadata>
        <reason>OK</reason>
        <result>1</result>
        <version>1</version>
        <command>setminimumpasswordstrengths</command>
    </metadata>
</result>


Note:

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

Parameters

Note:

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:

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:

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:

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:

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:

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.

 

Function information

API Version:

WHM API 1

Available in:

WHM 11+

Methods:

GET, POST

Required Parameters:

(none)

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

  • Some functions and parameters may require that you authenticate as the root user.
  • You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.
  

Find a function

Related functions