Description

This function changes the home directory for FTP accounts.

Examples 




https://hostname.example.com:2083/cpsess##########/execute/Ftp/set_homedir?user=example1&domain=example.com&homedir=example1%2F



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Set the home directory for the example1 FTP user.
$new_quota = $cpanel->uapi(
    'Ftp', 'set_homedir',
    array(
        'user' 	   	=> 'example1',
        'domain'  	=> 'example.com',
		'homedir'	=> 'example1/",
         )
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Set the home directory for the example1 FTP user.
my $set_homedir = $cpliveapi->uapi(
    'Ftp', 'set_quota',
    {
        'user'  	=>	'example1',
        'domain' 	=>	'example.com',
		'homedir'	=>	'example1/',
    }
);

 



<!-- Set the home directory for the ftpaccount FTP user. -->
[% execute( 'Ftp', 'set_homedir', { user => 'example1', domain => 'example.com', homedir => 'example1/' } ); %]

 



uapi --user=username Ftp set_homedir user=example1 domain=example.com homedir=example1/



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

   },
   "data":null
}



Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The FTP account username.

The username of an FTP account on the cPanel account.

example1
domainstring

The user's associated domain.

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

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

The FTP account's home directory.

This parameter defaults to the user@domain subdirectory in the cPanel account's home directory with the name, where user and domain represent the user and domain parameters.

A relative path from the cPanel account's home directory.

example1/

Returns

This function returns only metadata.