cPanel API 2 Functions - WebDisk::delwebdisk - Knowledgebase

Description

This function deletes a Web Disk account.

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

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Remove the "user@example.com" webdisk account
$remove_webdisk = $cpanel->api2(
    'WebDisk', 'delwebdisk',
 array(
        'login' => 'user@example.com',
  )
);

 

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Remove the "user@example.com" webdisk account

my $remove_webdisk = $cpliveapi->api2(

'WebDisk', 'delwebdisk',

{

'login' => 'user@example.com',

}

);

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 delwebdisk login=user%40example.com

Notes:

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

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "delwebdisk",
    "data": [
      {
        "login": "user@example.com"
      }
    ],
    "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 account's full username.	The full username, which includes the at symbol (@) and the domain name.	user@example.com

Parameters

Type

Description

Possible values

Example

string

Required

The account's full username.

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

user@example.com

Returns

Return	Type	Description	Possible values	Example
login	string	The account's full username.	The full username, which includes the at symbol (@) and the domain name.	user@example.com
reason	string	A reason for failure. Note: This function only returns areason 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