Description

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

Examples




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



$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',
  ) 
);

 



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',
  }
);

 




cpapi2 --user=username WebDisk listwebdisks regex=user%40example.com



{
  "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"
  }
}



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.

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