# cPanel API 2 Functions - WebDisk::listwebdisks Warning: The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2. ## Description This function lists a cPanel account's [Web Disk](https://docs.cpanel.net/cpanel/files/web-disk/) accounts. Warning: We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists. Important: When you disable the [*Web Disk* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function. ## Examples WHM API (JSON) ```undefined 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=listwebdisks®ex=user%40example.com ``` Note: For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation. LiveAPI PHP Class ```undefined syntaxhighlighter-pre $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](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system). LiveAPI Perl Module ```undefined syntaxhighlighter-pre 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](/guides/guide-to-the-liveapi-system). cPanel Tag System (deprecated) Warning: - cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system). - 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation. Command Line ```undefined syntaxhighlighter-pre cpapi2 --user=username WebDisk listwebdisks regex=user%40example.com ``` div 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](/cpanel-api-2/) documentation or run the `cpapi2 --help` command. - If you run CloudLinux™, you **must** use the full path of the `cpapi2` command: ```undefined syntaxhighlighter-pre /usr/local/cpanel/bin/cpapi2 ``` br Output (JSON) ```undefined syntaxhighlighter-pre { "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](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls. ## Parameters table thead tr th Parameters th strong Type th strong Description th strong Possible values th strong Example tbody tr td code regex td em string td p A a Perl Compatible Regular Expression (PCRE) that filters the function call's results. p If you do not use this parameter, the function lists all of the account's Web Disk accounts. td A valid PCRE. td code user@example.com ## Returns table thead tr th strong strong Return th strong Type th strong Description th strong Possible values th strong Example tbody tr td code mainport td em integer td The account's non-SSL port for Web Disk. td A positive integer. td code 2077 tr td code private td em Boolean td Whether the account is private or public. td ul li code 1 — Private. li code 0 — Public. td code 0 tr td code reldir td em string td The account's home directory. td A valid directory path, span relative to the user's home directory. td code /public_html/webdav tr td code sslport td em integer td The account's SSL port for Web Disk. td A positive integer. td code 2078 tr td code login td em string td The account's full username. td The full username, which includes the at symbol ( code @ ) and the domain name. td code user@example.com tr td code homedir td em string td The path to the account's home directory. td A valid absolute file path. td code /home/example/public_html/webdav tr td code domain td em string td The account's domain name. td A valid domain name. td code example.com tr td code user td em string td The account's username. td A valid username. td code user tr td code hasdigest td em Boolean td Whether the account has Digest Authentication enabled. td ul li code 1 — Enabled. li code 0 — Disabled. td code 1 tr td code perms td em string td The account's permissions. td ul li code rw — Read-write permissions. li code ro — Read-only permissions. td code rw tr td code reason td em string td p A reason for failure. p This function only returns a code reason value if it failed. td p A string that describes the error. td code This is an error message. tr td code result td em Boolean td p Whether the function succeeded. td ul li code 1 — The function succeeded. li code 0 — The function failed. td code 1