cPanel API 2 Functions - WebDisk::setstatus - Knowledgebase

Description

This function changes a Web Disk account's permissions.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

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=setstatus&login=user%40example.com&on=1

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Change the permission to "public" for "user@example.com"
$change_permission = $cpanel->api2(
    'WebDisk', 'setstatus',
 array(
        'login' => 'user@example.com',
        'on' => '1',
  )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Change the permission to "public" for "user@example.com"
my $change_permission = $cpliveapi->api2(
    'WebDisk', 'setstatus',
{
        'login' => 'user@example.com',
        'on' => '1',
   }
);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read ourDeprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

Command Line

cpapi2 --user=username WebDisk setstatus on=1 login=user%40example.com

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "setstatus",
    "data": [
      {
        "private": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "WebDisk"
  }
}

Note:

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

Parameters

Parameters	Type	Description	Possible values	Example
login	string	Required The login name.	The full username, which includes the at symbol (@) and the domain name.	user@example.com
on	Boolean	Required Whether to set the directory's permissions to public or private.	1 — Private (0700). 0 — Public (0755).	1

Parameters

Type

Description

Possible values

Example

string

Required

The login name.

The full username, which includes the at symbol (@) and the domain name.

user@example.com

Boolean

Required

Whether to set the directory's permissions to public or private.

1 — Private (0700).
0 — Public (0755).

Returns

Return	Type	Description	Possible values	Example
private	Boolean	Whether the directory's permissions are public or private.	1 — Private. 0 — Public.	1
reason	string	A reason for failure. Note: This function only returns a reason value if it failed.	A string that describes the error.	This is an error message.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories