Description
This function changes the Web Disk home directory's permissions.
Examples
cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/WebDisk/set_permissions?user=example1%40example.com&perms=rw
LiveAPI PHP Class
$cpanel = new CPANEL();
$new_permissions = $cpanel->uapi(
'WebDisk', 'set_permissions',
array(
'user' => 'example1@example.com',
'perms' => 'rw",
)
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $set_permissions = $cpliveapi->uapi(
'WebDisk', 'set_permissions',
{
'user' => 'example1@example.com',
'perms' => 'rw',
}
);
cPanel Template Toolkit
[% execute( 'WebDisk', 'set_permissions', { user => 'example1@example.com', perms => 'rw' } ); %]
Command Line
uapi --user=username WebDisk set_permissions user=example1%40example.com perms=rw
|
Output (JSON)
{
"messages":null,
"errors":null,
"status":1,
"metadata":{
},
"data":null
}
Parameters
|
Parameter
|
Type
|
Description
|
Possible values
|
Example
|
|
user
|
string
|
Required
The Web Disk account's username.
|
The username of a Web Disk account on the cPanel account.
|
example1@example.com
|
|
perms
|
string
|
Required
The Web Disk account's home directory file permissions.
|
- ro — Read-only permissions.
- rw — Read and write permissions.
|
rw
|
Returns
This function only returns metadata.
