UAPI Functions - Ftp::set_homedir - Knowledgebase

Description

This function changes the home directory for FTP accounts.

Examples

cPanel or Webmail Session URL

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

 LiveAPI PHP Class

$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/",
         )
);

 LiveAPI Perl Module

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

cPanel Template Toolkit

[% execute( 'Ftp', 'set_homedir', { user => 'example1', domain => 'example.com', homedir => 'example1/' } ); %]

Command Line

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

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
user	string	Required The FTP account username.	The username of an FTP account on the cPanel account.	example1
domain	string	The user's associated domain. This parameter defaults to the cPanel account's primary domain.	A domain that the cPanel account owns.	example.com
homedir	string	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.

Knowledgebase

Categories

Categories