# cPanel API 2 Functions - PasswdStrength::get_required_strength

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

This functionr retrieves the application's required minimum password strength.

Warning:
We **strongly** recommend that you use the following [UAPI](https://api.docs.cpanel.net/cpanel/introduction/) function instead of this function:

- [`PasswdStrength::get_required_strength`](/openapi/cpanel/operation/get_required_strength/) — This function retrieves an application's minimum required password strength.


## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=PasswdStrength&cpanel_jsonapi_func=get_required_strength&app=ftp
```

Note:
For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Check the minimum required strength for ftp passwords
$check_strength = $cpanel->api2(
    'PasswdStrength', 'get_required_strength',
    array(
        'app' => 'ftp',
    )
);
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


```undefined syntaxhighlighter-pre
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Check the minimum required strength for ftp passwords
my $check_strength = $cpliveapi->api2(
    'PasswdStrength', 'get_required_strength',
    {
        'app' => 'ftp',
    }
);
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) system to call the cPanel APIs. Examples are **only** present in order to help developers move from the old cPanel tag system to our [LiveAPI](/guides/guide-to-the-liveapi-system).
- cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
- For more information, read our [Deprecated cPanel Tag Usage](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username PasswdStrength appstrengths app=ftp
```

div
Notes:

- You **must** URI-encode values.
- `username` represents your account-level username.
- You **must** include the `--user=username` option.
- For more information and additional output options, read our [Guide to cPanel API 2](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "get_required_strength",
    "data": [
      {
        "strength": 0
      }
    ],
    "event": {
      "result": 1
    },
    "module": "PasswdStrength"
  }
}
```

Note:
Use cPanel's *[API Shell](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

table
colgroup
col
col
col
col
col
thead
tr
th
strong
Parameter
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
app
td
em
string
td
p
strong
Required
p
The application's name.
td
ul
li
code
htaccess
li
code
passwd
li
code
ftp
li
code
createacct
li
code
bandmin
li
We removed the
code
bandmin
 parameter value in cPanel 
&
 WHM version 58.
li
code
cpaddons
li
code
pop
li
code
sshkey
li
code
postgres
li
code
webdisk
li
code
mysql
td
code
ftp
## Returns

table
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
strength
td
em
integer
td
The application's required minimum password strength.
td
An integer between 
code
0
 and 
code
100
.
td
code
0
tr
td
code
reason
td
em
string
td
A reason for failure.

p
This function only returns a 
code
reason
 value if it failed.
td
p
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1