cPanel API 2 Functions - WebDisk::set_perms
The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.
Description
This function manages a Web Disk account's permissions.
We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.
When you disable the Web Disk role, the system disables this function.
Examples
WHM API (JSON)
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=WebDisk&cpanel_jsonapi_func=set_perms&login=user@example.com&perms=roFor more information, read our Calls from the WHM API documentation.
LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
// Set permissions for "user@example.com"
$set_perms = $cpanel->api2(
'WebDisk', 'set_perms',
array(
'login' => 'user@example.com',
'password' => '12345luggage',
'perms' => 'ro',
)
);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 permissions for "user@example.com"
my $set_perms = $cpliveapi->api2(
'WebDisk', 'set_perms',
{
'login' => 'user@example.com',
'password' => '12345luggage',
'perms' => 'ro',
}
);For more information, read our Guide to the LiveAPI System.
cPanel Tag System (deprecated)
- cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI .
- cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
- For more information, read our Deprecated cPanel Tag Usage documentation.
Command Line
cpapi2 --user=username WebDisk set_perms on=1 login=user%40example.com perms=ro- You must URI-encode values.
-
usernamerepresents your account-level username. -
You
must
include the
--user=usernameoption. -
For more information and additional output options, read our
Guide to cPanel API 2
documentation or run the
cpapi2 --helpcommand. -
If you run CloudLinux™, you
must
use the full path of the
cpapi2command:/usr/local/cpanel/bin/cpapi2
Output (JSON)
{
"cpanelresult": {
"apiversion": 2,
"func": "set_perms",
"data": [
{
"reason": "Permissions set to: read-only",
"result": 1
}
],
"event": {
"result": 1
},
"module": "WebDisk"
}
}Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.
Parameters
| Parameter | Type | Description | Possible values | Example |
|---|---|---|---|---|
login |
string | Required The account's full username. |
The full username, which includes the at symbol (@) and the domain name. |
user@example.com |
password |
string | Required The account's password. |
A valid password. |
12345luggage |
perms |
string | Required The account's new Web Disk permissions. |
|
ro |
Returns
| Return | Type | Description | Possible values | Example |
|---|---|---|---|---|
reason |
string | The account's new permissions. |
|
Permissions set to: read-only. |
reason |
string |
A reason for failure. This function only returns a |
A string that describes the error. |
This is an error message. |
result |
Boolean | Whether the function succeeded. |
|
1 |