Sign in

v1

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

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.

get/WebDisk/set_homedir

Query parameters

homedirstring path required
Example:example1/

The Web Disk account's home directory.

userstring email required
Example:example1@example.com

The Web Disk account username.

private0 | 1

Whether to set the Web Disk directory's permissions to public or private.

  • 1 - Private (0700)
  • 0 - Public (0755)

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_homedir",
  "module": "WebDisk",
  "result": {
    "status": 1
  }
}