Skip to content
Last updated

cPanel API 2 Functions - WebDisk::setstatus

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

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.

Important:

When you disable the Web Disk role, the system disables this function.

Examples


WHM API (JSON)

syntaxhighlighter-pre
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
Note:

For more information, read our Calls from the WHM API documentation.

LiveAPI PHP Class

syntaxhighlighter-pre
$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',
  )
);
Note:

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

LiveAPI Perl Module

syntaxhighlighter-pre
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',
   }
);
Note:

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

cPanel Tag System (deprecated)

Warning:
  • 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

syntaxhighlighter-pre
cpapi2 --user=username WebDisk setstatus on=1 login=user%40example.com
Notes:
  • You must URI-encode values.

  • username represents your account-level username.

  • You must include the --user=username option.

  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.

  • If you run CloudLinux™, you must use the full path of the cpapi2 command:

    syntaxhighlighter-pre
    /usr/local/cpanel/bin/cpapi2

Output (JSON)

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

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

Parameters

ParametersTypeDescriptionPossible valuesExample
loginstring

Required

The login name.

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

Required

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

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

Returns

ReturnTypeDescriptionPossible valuesExample
privateBooleanWhether the directory's permissions are public or private.
  • 1 — Private.
  • 0 — Public.
1
reasonstring

A reason for failure.

This function only returns a reason value if it failed.

A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1