UAPI Functions - WebDisk::set_homedir - Knowledgebase

Description

This function changes the home directory for a Web Disk account.

Examples

cPanel or Webmail Session URL

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

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Set the home directory for the example1 Web Disk user.
$new_permissions = $cpanel->uapi(
    'WebDisk', 'set_homedir',
    array(
        'user'      => 'example1@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 Web Disk user.
my $set_homedir = $cpliveapi->uapi(
    'WebDisk', 'set_homedir',
    {
        'user'      =>   'example1@example.com',
        'homedir'   =>   'example1/',
    }
);

cPanel Template Toolkit

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

Command Line

uapi --user=username WebDisk set_homedir user=example1%40example.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 Web Disk account username.	The username of a Web Disk account on the cPanel account.	example1@example.com
homedir	string	Required The Web Disk account's home directory.	A relative path from the cPanel account's home directory.	example1/
private	Boolean	Whether to set the Web Disk directory's permissions to public or private. This parameter defaults to 0.	1 — Private (0700). 0 — Public (0755).	0

Returns

This function only returns metadata.

Knowledgebase

Categories

Categories