cPanel module

WebDisk

4 functions, invoked through the cpanel_uapi tool.

scope cpanel:uapi

Call any function with cpanel_uapi(service_id, module="WebDisk", function, params). Live availability depends on the cPanel features JetHost has enabled on your account — call list_cpanel_operations to see what is active.

delete_user GET#

Delete Web Disk account

This function deletes a Web Disk account.

Important:

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

destroyintegerRequired

Whether to recursively delete the Web Disk account's folder and all of its contents. 1 - Delete the folder for the Web Disk account 0 - Do not delete the folder for the Web Disk account.

userstringRequired

The Web Disk account username.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.

set_homedir GET#

Update Web Disk home directory location

This function changes the home directory for a Web Disk account.

Important:

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

homedirstringRequired

The Web Disk account's home directory.

userstringRequired

The Web Disk account username.

privateintegerOptional

Whether to set the Web Disk directory's permissions to public or private. 1 - Private (0700) 0 - Public (0755)

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.

set_password GET#

Update Web Disk account password

This function changes the Web Disk account's password.

Important:

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

passwordstringRequired

The Web Disk account's password.

userstringRequired

The Web Disk account username.

enabledigestintegerOptional

Whether to enable Digest Authentication. 1 - Enable Digest Authentication. 0 - Disable Digest Authentication.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.

set_permissions GET#

Update Web Disk home directory permissions

This function changes the Web Disk home directory's permissions.

Important:

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

permsstringRequired

The Web Disk account's home directory file permissions. ro — Read-only permissions. rw — Read and write permissions.

userstringRequired

The Web Disk account's username.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.