Child pages
  • cPanel API 2 Functions - WebDisk::listwebdisks
Skip to end of metadata
Go to start of metadata

Description

This function lists a cPanel account's Web Disk accounts.


Warning:

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

Important:

In cPanel & WHM version 76 and later, when you disable the WebDisk role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

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


Note:

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

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List webdisk accounts based on "user@example.com" filter.
$create_webdisk = $cpanel->api2(
    'WebDisk', 'listwebdisks',
 array(
        'regex' => 'user@example.com',
  ) 
);


Note:

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.
 
# List webdisk accounts based on "user@example.com" filter.
my $create_webdisk = $cpliveapi->api2(
    'WebDisk', 'listwebdisks',
{ 
        'regex' => 'user@example.com',
  }
);


Note:

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

 

 cPanel Tag System (deprecated)


Warnings:

  • 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. 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 listwebdisks regex=user%40example.com


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • 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:

    /usr/local/cpanel/bin/cpapi2

 Output (JSON)
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listwebdisks",
    "data": [
      {
        "mainport": "2077",
        "hasdigest": 1,
        "private": 0,
        "reldir": "public_html/anotheruser",
        "login": "anotheruser@example.com",
        "homedir": "/home/example/public_html/anotheruser",
        "sslport": "2078",
        "domain": "example.com",
        "user": "anotheruser",
        "perms": "rw"
      },
      {
        "mainport": "2077",
        "hasdigest": 1,
        "private": 0,
        "reldir": "public_html/webdav",
        "login": "user@example.com",
        "homedir": "/home/example/public_html/webdav",
        "sslport": "2078",
        "domain": "example.com",
        "user": "user",
        "perms": "rw"
      }
    ],
    "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
regexstring

A Perl Compatible Regular Expression (PCRE) that filters the function call's results.

If you do not use this parameter, the function lists all of the account's Web Disk accounts.

A valid PCRE.user@example.com

Returns

Return TypeDescriptionPossible valuesExample
mainportintegerThe account's non-SSL port for Web Disk.A positive integer.2077
privateBooleanWhether the account is private or public.
  • 1 — Private.
  • 0 — Public.
0
reldirstringThe account's home directory.A valid directory path, relative to the user's home directory./public_html/webdav
sslportintegerThe account's SSL port for Web Disk.A positive integer.2078
loginstringThe account's full username.The full username, which includes the at symbol (@) and the domain name.user@example.com
homedirstringThe path to the account's home directory.A valid absolute file path./home/example/public_html/webdav
domainstringThe account's domain name.A valid domain name.example.com
userstringThe account's username.A valid username.user
hasdigestBooleanWhether the account has Digest Authentication enabled.
  • 1 — Enabled.
  • 0 — Disabled.
1
permsstringThe account's permissions.
  • rw — Read-write permissions.
  • ro — Read-only permissions.
rw
reasonstring

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.
resultBoolean

Whether the function succeeded.

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