We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Child pages
  • UAPI Functions - Ftp::passwd
Skip to end of metadata
Go to start of metadata

Description

This function changes an FTP account's password.

Important:

In cPanel & WHM version 76 and later, when you disable the FTP role, the system disables this function.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Ftp/passwd?user=ftpaccount&pass=12345luggage


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Change the FTP account password.
$change_passwd = $cpanel->uapi(
    'Ftp', 'passwd',
    array(
        'user'    => 'ftpaccount',
        'pass'    => '12345luggage',
         )
);


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 FTP account password.
my $change_passwd = $cpliveapi->uapi(
    'Ftp', 'passwd',
    {
        'user'    => 'ftpaccount',
        'pass'    => '12345luggage',
    }
);


Note:

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

 

 Command Line
uapi --user=username Ftp passwd user=ftpaccount pass=12345luggage


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  

   },
   "data":null
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

The user's associated domain.

This parameter defaults to the cPanel account's primary domain.

Note:

We introduced this parameter in cPanel & WHM version 54.

A domain that the cPanel account owns.example.com
userstring

Required

The FTP account username.

The username for an FTP account on the cPanel account.

ftpaccount  
passstring

Required

The FTP account's new password.

A secure password.

12345luggage

Returns

This function returns only metadata.