latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Passwords

Update cPanel account password

This function modifies a cPanel or reseller account's password.

Note

  • When modifying the root password, this will only update the password for the root system user, but not for the root MySQL user.
  • To update the MySQL root user's password, use set_local_mysql_root_password.
get/passwd

Query parameters

passwordstring required
Example:12345luggage

The account's new password.

userstring required
Example:username

The account's username.

db_pass_update0 | 1

Whether to also change the account's MySQL® password.

  • 1 — Also update the account's MySQL password to match the password value.
  • 0 — Do not update.
digestauth0 | 1
Example:1

Whether to enable Digest Authentication for the account. If you do not specify a value, the account retains its current Digest Authentication setting. This is an alias for the enabledigest parameter.

  • 1 — Enable.
  • 0 — Disable.
enabledigest0 | 1
Example:1

Whether to enable Digest Authentication for the account. If you do not specify a value, the account retains its current Digest Authentication setting.

  • 1 — Enable.
  • 0 — Disable.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "app": [
      "ftp"
    ]
  },
  "metadata": {
    "command": "passwd",
    "reason": "Password changed for user “username”.",
    "result": 1,
    "version": 1
  }
}