WHM API 1 / Account Management

WHM API 1 get_homedir_roots

Find the endpoint, CLI syntax and practical purpose of this cPanel command, with a direct link to the official documentation.

What this command does

The cPanel documentation summary for this operation is: Return home directories list.

In Hostilla.pl this page helps identify the exact API operation before using automation, reseller integrations or a support request.

Command details

API
WHM API 1 11.136.0.25
Category
Account Management
Method and path
GET /get_homedir_roots
Operation ID
get_homedir_roots
CLI example
whmapi1 get_homedir_roots

Open official cPanel documentation

Practical request workflow

WHM API 1 get_homedir_roots should be run only after the target account and expected result are known. Start with a read-only lookup when one is available, then make the smallest required change and verify the resource again.

  1. Verify reseller or administrator authorization and the exact target account.
  2. Read current account properties and dependent domains before changing them.
  3. Use a narrowly scoped token and submit only the required parameters to get_homedir_roots.
  4. Reload the account state and test the customer-facing service after the change.

CLI request example

whmapi1 get_homedir_roots

How to read the response

Check the API success flag, messages, warnings and returned data object. Confirm that identifiers refer to the intended account, then perform a separate read or service-level test.

Record the request time, account and domain together with the returned status. A successful transport response does not by itself prove that the requested resource was created, changed or deleted exactly as intended.

Questions before automation

What permission does WHM API 1 get_homedir_roots require?

This WHM API operation requires authorized reseller or administrator privileges and an exact target account.

What should I check before running get_homedir_roots?

Verify reseller or administrator authorization and the exact target account. Read current account properties and dependent domains before changing them.

How do I confirm that get_homedir_roots worked?

Check the API success flag, messages, warnings and returned data object. Confirm that identifiers refer to the intended account, then perform a separate read or service-level test.

Hostilla.pl usage notes

WHM API commands can affect server or reseller-level resources. They should be used only by authorized administrators or reseller integrations.

Need this operation for your hosting account? Contact Hostilla.pl support with the account name, domain and expected result. We will help select a safe API path.

Related practical guides

Related API navigation