Update FTP account's password

This function changes an FTP account's password.

Important:

When you disable the FTP role, the system disables this function.

Authorizations:
query Parameters
pass
required
string

The FTP account's new password.

Example: pass=12345luggage
user
required
string

The FTP account username.

Example: user=ftpaccount
domain
string

The user's associated domain.

Note:

This parameter defaults to the cPanel account's primary domain

Example: domain=example.com

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --user=username Ftp passwd user='ftpaccount' pass='12345luggage'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "passwd",
  • "module": "Ftp",
  • "result": {
    • "data": null,
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}