{"id":2922,"date":"2025-09-01T13:16:26","date_gmt":"2025-09-01T13:16:26","guid":{"rendered":"https:\/\/pheonixsolutions.com\/knowledge-base\/?p=2922"},"modified":"2025-09-01T13:16:28","modified_gmt":"2025-09-01T13:16:28","slug":"how-to-add-an-addon-domain-in-cpanel-with-cli-uapi","status":"publish","type":"post","link":"https:\/\/pheonixsolutions.com\/knowledge-base\/2025\/09\/01\/how-to-add-an-addon-domain-in-cpanel-with-cli-uapi\/","title":{"rendered":"How to Add an Addon Domain in cPanel with CLI (uapi)?"},"content":{"rendered":"\n

Introduction:<\/strong><\/h3>\n\n\n\n

Managing domains through the cPanel graphical interface is common, but for system administrators and developers, the command line often provides more speed, flexibility, and opportunities for automation. Using cPanel\u2019s UAPI (Universal API)<\/strong>, we can easily add an Addon Domain<\/strong> directly from the command line.<\/p>\n\n\n\n

Steps to Add an Addon Domain Using UAPI:<\/strong><\/h5>\n\n\n\n

Step 1:<\/strong><\/p>\n\n\n\n

Log in to cPanel server as the cPanel user<\/p>\n\n\n\n

ssh username@ServerIP<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Note: <\/strong>Replace username<\/code> with the cPanel account\u2019s username.<\/p>\n\n\n\n

Step 2:<\/strong><\/p>\n\n\n\n

Before adding a new addon domain, we can list existing domains linked to the cPanel account<\/p>\n\n\n\n

uapi –user=username DomainInfo list_domains<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

This command will display primary, addon, parked, and subdomains<\/strong> already configured. <\/p>\n\n\n\n

Step 3:<\/strong><\/p>\n\n\n\n

Run the following command to add a new addon domain<\/p>\n\n\n\n

uapi –user=username SubDomain addsubdomain domain=test.example.com<\/code> rootdomain=example.com<\/code> dir=public_html\/example<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Explanation of options:<\/h5>\n\n\n\n