Subdomains
Change a subdomain or addon domain document root
This function changes the document root for a subdomain or addon domain that the calling cPanel user owns.
Important:
- This function does not apply to the account's primary domain. Use the WHM API set_primary_domain_docroot function to change the document root for a primary domain.
- The target directory must already exist before you call this function. The function does not create it.
- This function does not move any files. You must ensure that the files exist in the new path when you call this function.
- Any parked domains (ServerAlias entries) on the affected domain will inherit the new document root.
- AutoSSL HTTP-01 renewals will fail if the new document root is empty or missing at renewal time.
- To revert a document root change, call this function again with the original path.
When you disable the Web Server role, the system disables this function.
get/SubDomain/changedocroot
Query parameters
docrootstring path required
Example:public_html/myapp/public
The new document root as a path relative to the user's home directory. The target directory must already exist, and the path must begin with public_html/ if the Restrict document roots to public_html value is set to On in WHM's Tweak Settings interface (WHM >> Home >> Server Configuration >> Tweak Settings).
domainstring domain required
Example:sub.example.com
The full domain name of the subdomain or addon domain whose document root you want to change. The domain must belong to the calling cPanel user.
Response
HTTP Request was successful.
Example response
{
"data": {
"documentroot": "/home/username/public_html/myapp/public"
},
"status": 1
}