# cPanel API 2 Functions - Passwd::change_password

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

## Description

This function changes a cPanel account's password.

Warning:
We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists.

## 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=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](/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.

// 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](/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.

# 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](/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 Passwd change_password user=example oldpass=luggage12345 newpass=luggage54321 enablemysql=1 enabledigest=1
```

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": "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](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

table
thead
tr
th
strong
Parameter
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
user
td
em
string
td
p
strong
Required
p
The account name.
td
A valid cPanel account username.
code
td
code
username
tr
td
code
oldpass
td
em
string
td
p
strong
Required
p
The account's current password.
td
A secure password.
td
code
luggage12345
tr
td
code
newpass
td
em
string
td
p
strong
Required
p
The new password.
td
A secure password.
td
code
luggage54321
tr
td
code
enablemysql
td
em
Boolean
td
p
Whether to update the account's MySQL password.
p
This parameter defaults to 
code
0
.
td
ul
li
code
1
 — Update password.
li
code
0
 — Do 
strong
not
 update password
td
code
1
tr
td
code
enabledigest
td
em
Boolean
td
p
Whether to enable Digest Authentication on the account.
p
You 
strong
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:
ul
li
The domain has an SSL certificate that a recognized certificate authority signed.
li
You can connect to Web Disk with SSL over port 
code
2078
.
p
This parameter defaults to 
code
0
.
td
ul
li
code
1
 — Enable Digest Authentication.
li
code
0
 — Do 
strong
not
 update Digest Authentication.
td
code
1
## Returns

table
thead
tr
th
Return
th
Type
th
Description
th
Possible values
th
Example
tbody
tr
td
code
passwdoutput
td
em
string
td
The function's raw output.
td
A result message.
td
code
Password for \u201cexample\u201d has been changed.\nUpdating FTP passwords for example\nFTP password files updated.\nFTP vhost passwords synced\n
tr
td
code
statustxt
td
em
string
td
The text of the result message.
td
A result message.
td
code
Password changed for user \u201cexample\u201d
tr
td
code
applist
td
em
array of hashes
td
An array of hashes that contains the applications for which the system changed passwords.
td
This array of hashes includes the 
code
app
 return.
td
tr
td
p
code
app
td
em
string
td
p
An application name.
p
The function returns this value in the 
code
applist
 hash.
td
A valid application name.
td
code
postgresql
tr
td
code
reason
td
em
string
td
div
p
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