cPanel API 1 Functions - Ftp::passwdftp - Knowledgebase

Description

This function changes an FTP user's password.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

UAPI (recommended) — Ftp::passwd — This function changes an FTP account's password.
cPanel API 2 — Ftp::passwd — This function changes an FTP user's password.

Examples

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$change_ftppass = $cpanel->api1('Ftp','passwdftp',array('user','12345luggage') ); // Call the function.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $change_ftppass = $cpliveapi->api1('Ftp','passwdftp',['user','12345luggage'] ); # Call the function.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Ftp::passwdftp($FORM('user','pass'))">

Command Line

cpapi1 --user=username Ftp passwdftp user=user pass=12345luggage

Output (none)

This function does not return output.

Parameters

Parameter	Type	Description	Possible values	Example
user	string	Required The FTP username.	A valid FTP username on the account.	user
pass	string	Required The FTP password.	A secure password.	12345luggage

Parameter

Type

Description

Possible values

Example

user

string

Required

The FTP username.

A valid FTP username on the account.

user

pass

string

Required

The FTP password.

A secure password.

12345luggage

Returns

This function does not return output.

Knowledgebase

Categories

Categories