Page tree
Skip to end of metadata
Go to start of metadata

 

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

Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

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

Note:

For more information, read our Guide to the LiveAPI System.

 

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

Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Template Toolkit
<!-- Set the home directory for the example1 Web Disk user. -->
[% execute( 'WebDisk', 'set_homedir', { user => 'example1@example.com', homedir => 'example1' } ); %]

Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 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.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  

   },
   "data":null
}

Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The Web Disk account username.

The username of a Web Disk account on the cPanel account.

example1@example.com
homedirstring

Required

The Web Disk account's home directory.

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

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.