cPanel API 2 Functions - Passwd::change_password - Knowledgebase

Description

This function changes an account's password.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Passwd&cpanel_jsonapi_func=change_password&oldpass=luggage12345&newpass=luggage54321&user=example

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Change the password for "example" from "luggage12345" to "luggage54321"
$skroob_luggage = $cpanel->api2(
    'Passwd', 'change_password', 
    array(
        'user' => 'example',
        'oldpass' => 'luggage12345',
        'newpass' => 'luggage54321',
    ) 
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Change the password for "example" from "luggage12345" to "luggage54321"
my $skroob_luggage = $cpliveapi->api2(
    'Passwd', 'change_password',
    {
        'user' => 'example',
        'oldpass' => 'luggage12345',
        'newpass' => 'luggage54321',
    }
);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only 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": "change_password",
    "data": [
      {
        "passwdoutput": "Password for \u201cexample\u201d has been changed.\nUpdating FTP passwords for example\nFTP password files updated.\nFTP vhost passwords synced\n",
        "status": 1,
        "applist": [
          {
            "app": "system"
          },
          {
            "app": "ftp"
          },
          {
            "app": "mail"
          },
          {
            "app": "postgresql"
          }
        ],
        "statustxt": "Password changed for user \u201cexample\u201d."
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Passwd"
  }
}

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
user	string	Required The account name.	A valid cPanel account username.	username
oldpass	string	Required The account's current password.	A secure password.	luggage12345
newpass	string	Required The new password.	A secure password.	luggage54321

Returns

Return	Type	Description	Possible values	Example
passwdoutput	string	The function's raw output.	A result message.	Password for \u201cexample\u201d has been changed.\nUpdating FTP passwords for example\nFTP password files updated.\nFTP vhost passwords synced\n
statustxt	string	The text of the result message.	A result message.	Password changed for user \u201cexample\u201d
reason	string	A reason for failure. Note: This function only returns areasonvalue if it failed.	A string that describes the error.	This is an error message.
result	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories