UAPI Functions - Ftp::passwd - Knowledgebase

Description

This function changes an FTP account's password.

Examples

cPanel or Webmail Session URL

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

 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',
         )
);

 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',
    }
);

cPanel Template Toolkit

[% execute( 'Ftp', 'passwd', { user => 'ftpaccount', pass => '12345luggage' } ); %]

Command Line

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

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{ 
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{ 
 
   },
   "data":null
}

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
domain	string	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
user	string	Required The FTP account username.	The username for an FTP account on the cPanel account.	ftpaccount
pass	string	Required The FTP account's new password.	A secure password.	12345luggage

Returns

This function returns only metadata.

Knowledgebase

Categories

Categories