Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function retrieves an application's minimum required password strength.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/PasswdStrength/get_required_strength?app=webdisk

Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Get the minimum password strength for webdisk.
$get_required_strength = $cpanel->uapi(
    'PasswdStrength', 'get_required_strength',
    array(
        'app'    => 'webdisk',
    )
);

Note:

For more information, read our Guide to the LiveAPI System.

 

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Get the minimum password strength for webdisk.
my $get_required_strength = $cpliveapi->uapi(
    'PasswdStrength', 'get_required_strength',
    {
        'app'    => 'webdisk',
    }
);

Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Template Toolkit
<!--  Get the minimum password strength for webdisk. -->
[% data = execute( 'PasswdStrength', 'get_required_strength', { app => 'webdisk'} ); %]
[% FOREACH q = data %]
     <p>
         [% q %]
     </p>
[% END %]

Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 Command Line
uapi --user=username PasswdStrength get_required_strength app=webdisk

Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
     "messages": null,
     "errors": null,
     "status": 1,
     "data": {
         "strength": 0
     }
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
appstring

Required

The application's name.

  • bandmin

    Note:

    We removed the bandmin parameter value in cPanel & WHM version 58.
  • cpaddons
  • createacct
  • ftp
  • htaccess
  • mysql
  • passwd
  • pop
  • postgres
  • sshkey
  • webdisk
  • virtual

    Note:

    We introduced the virtual parameter value in cPanel & WHM version 54.

webdisk

 

Returns

ReturnTypeDescriptionPossible valuesExample

strength

integerThe application's minimum password strength.A positive integer between 0 and 100 that represents the relative strength of the password.
0