Description
This function is deprecated and does not return useful output.
Examples
WHM API (JSON)
https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=ForcePassword&cpanel_jsonapi_func=update_force_password_flags
LiveAPI PHP Class
$cpanel = new CPANEL();
$call_function = $cpanel->api2(
'ForcePassword', 'update_force_password_flags',
);
LiveAPI Perl Module
$cpanel = new CPANEL();
$call_function = $cpanel->api2(
'ForcePassword', 'update_force_password_flags',
);
cPanel Tag System (deprecated)
Warning:
In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that youonly use the LiveAPI system to call the cPanel APIs.
cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
Output (JSON)
{
"cpanelresult": {
"apiversion": 2,
"func": "update_force_password_flags",
"data": [
null
],
"event": {
"result": 1
},
"module": "ForcePassword"
}
}
Parameters
This function does not accept parameters.
Returns
|
Return
|
Type
|
Description
|
Possible values
|
Example
|
|
result
|
boolean
|
Whether the function succeeded.
|
- 1 — The function succeeded.
- 0 — The function failed.
|
1
|
