cPanel API 2 Functions - WebDisk::set_homedir

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function manages a Web Disk account's home directory.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Important:

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

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=WebDisk&cpanel_jsonapi_func=set_homedir&login=user%40example.com&homedir=public_html%2Fwebdav&private=0

Note:

For more information, read our Calls from the WHM API documentation.

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

//  Set home directory for "user@example.com" to "public_html/webdav"
$set_homedir = $cpanel->api2(
    'WebDisk', 'set_homedir',
 array(
        'login' => 'user@example.com',
        'homedir' => 'public_html/webdav',
        'private' => '0',
  )
 );

Note:

For more information, read our Guide to the LiveAPI System.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Set home directory for "user@example.com" to "public_html/webdav"
my $set_homedir = $cpliveapi->api2(
    'WebDisk', 'set_homedir',
{
        'login' => 'user@example.com',
        'homedir' => 'public_html/webdav',
        'private' => '0',
  }
);

Note:

For more information, read our Guide to the LiveAPI System.

cPanel Tag System (deprecated)

Warning:

cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI 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 .
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 documentation.

Command Line

cpapi2 --user=username WebDisk set_homedir on=1 login=user%40example.com private=0

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 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "set_homedir",
    "data": [
      {
        "reason": "Home Directory set to: /public_html/webdav",
        "reldir": "/public_html/webdav",
        "result": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "WebDisk"
  }
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter Type Description Possible values Example

Parameter	Type	Description	Possible values	Example
`login`	string	Required The account's full username.	The full username, which includes the at symbol (`@`) and the domain name.	`user@example.com`
`homedir`	string	Required The account's home directory,	A valid directory path, relative to the cPanel account's home directory.	`public_html/webdav`
`private`	Boolean	Whether to set the home directory as public or private. This parameter defaults to `0`.	`1` — Private. `0` — Public.	`0`

login

string

Required

The account's full username.

The full username, which includes the at symbol (@) and the domain name.

user@example.com

homedir

string

Required

The account's home directory,

A valid directory path, relative to the cPanel account's home directory.

public_html/webdav

private

Boolean

Whether to set the home directory as public or private.

This parameter defaults to 0.

1 — Private.
0 — Public.

0

Returns

Return	Type	Description	Possible values	Example
`reason`	string	The account's new permissions.	`Permissions set to: read-only.` `Permissions set to: read-write.`	`Permissions set to: read-only.`
`reldir`	string	The account's home directory.	A valid directory path, relative to the cPanel account's home directory.	`public_html/webdav`
`reason`	string	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.`
`result`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`