cPanel UAPI / Subdomains

cPanel UAPI changedocroot

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: Change a subdomain or addon domain document root.

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

Command details

API
cPanel UAPI 11.136.0.25
Category
Subdomains
Method and path
GET /SubDomain/changedocroot
Operation ID
changedocroot
CLI example
uapi --user=USER SubDomain changedocroot

Open official cPanel documentation

Practical request workflow

cPanel UAPI changedocroot 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. Identify the owning cPanel account and the exact resource.
  2. Read the current state before executing a write operation.
  3. Run changedocroot with the minimum required permissions and parameters.
  4. Verify the returned metadata and perform an independent post-change check.

CLI request example

uapi --user=USER SubDomain changedocroot

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 cPanel UAPI changedocroot require?

Use the target cPanel account context or a least-privilege token allowed to perform this function.

What should I check before running changedocroot?

Identify the owning cPanel account and the exact resource. Read the current state before executing a write operation.

How do I confirm that changedocroot 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

UAPI commands normally act inside a single cPanel account. Use the least-privilege token or the account context required for the task.

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