v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
WebDisk
WebDisk Settings

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.

get/WebDisk/set_permissions

Query parameters

perms'ro' | 'rw' required
Example:rw

The Web Disk account's home directory file permissions.

  • ro — Read-only permissions.
  • rw — Read and write permissions.
userstring email required
Example:example1@example.com

The Web Disk account's username.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "set_permissions",
  "module": "WebDisk",
  "result": {
    "status": 1
  }
}