cPanel API 2 Functions - Passwd::change_password

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function changes a cPanel 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&enablemysql=1&enabledigestauth=1
Note:

For more information, read our Calls from the WHM API documentation.


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',
        'enablemysql' => '1',
        'enabledigest' => '1',
    )
);
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.

# Change the password for "example" from "luggage12345" to "luggage54321"
my $skroob_luggage = $cpliveapi->api2(
    'Passwd', 'change_password',
    {
        'user' => 'example',
        'oldpass' => 'luggage12345',
        'newpass' => 'luggage54321',
        'enablemysql' => '1',
        'enabledigest' => '1',
    }
);
Note:

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


cPanel Tag System (deprecated)

Warnings:
  • 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. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI .
  • 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 documentation.

Command Line

cpapi2 --user=username Passwd change_password user=example oldpass=luggage12345 newpass=luggage54321 enablemysql=1 enabledigest=1
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 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:
    /usr/local/cpanel/bin/cpapi2

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 (cPanel >> 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
enablemysql Boolean

Whether to update the account's MySQL password.

This parameter defaults to 0.

  • 1 — Update password.
  • 0 — Do not update password
1
enabledigest Boolean

Whether to enable Digest Authentication on the account.

You must enable Digest Authentication if you use Windows® Vista, Windows® 7, or Windows® 8, or Windows® 10 and you access Web Disk over a clear text, unencrypted connection. You do not need to enable Digest Authentication if you meet the following conditions:

  • The domain has an SSL certificate that a recognized certificate authority signed.
  • You can connect to Web Disk with SSL over port 2078.

This parameter defaults to 0.

  • 1 — Enable Digest Authentication.
  • 0 — Do not update Digest Authentication.
1

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
applist array of hashes An array of hashes that contains the applications for which the system changed passwords. This array of hashes includes the app return.

app

string

An application name.

The function returns this value in the applist hash.

A valid application name. postgresql
reason string

A reason for failure.

This function only returns a reason value 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