{"id":2892,"date":"2025-08-03T15:11:28","date_gmt":"2025-08-03T15:11:28","guid":{"rendered":"https:\/\/pheonixsolutions.com\/knowledge-base\/?p=2892"},"modified":"2025-08-03T15:11:32","modified_gmt":"2025-08-03T15:11:32","slug":"domain-listing-via-uapi-for-cpanel-user","status":"publish","type":"post","link":"https:\/\/pheonixsolutions.com\/knowledge-base\/2025\/08\/03\/domain-listing-via-uapi-for-cpanel-user\/","title":{"rendered":"Domain Listing via UAPI for cPanel User"},"content":{"rendered":"\n<p>This document provides details on using the <code>uapi<\/code> command-line tool to list all domains associated with a specific cPanel user account. The example focuses on retrieving domain information for the user &lt; cpanel username &gt; using the <code>DomainInfo::list_domains<\/code> function of the Universal API (UAPI).<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Command Used<\/h2>\n\n\n\n<pre class=\"wp-block-code\"><code>uapi --user=&lt;cpanelusername&gt; DomainInfo list_domains<\/code><\/pre>\n\n\n\n<p>This command queries and lists all domain-related data for the user, including:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Main domain<\/li>\n\n\n\n<li>Addon domains<\/li>\n\n\n\n<li>Parked domains (aliases)<\/li>\n\n\n\n<li>Subdomains<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\">Prerequisites<\/h2>\n\n\n\n<p>Before executing the command, ensure the following conditions are met:<\/p>\n\n\n\n<ol start=\"1\" class=\"wp-block-list\">\n<li>The server has a valid cPanel installation with UAPI available.<\/li>\n\n\n\n<li>SSH access is available with sufficient privileges (typically root).<\/li>\n\n\n\n<li>The user <code>pheonixsolutions<\/code> exists on the server and has domain configurations.<\/li>\n\n\n\n<li>The <code>uapi<\/code> tool is accessible in the server&#8217;s environment path (default on cPanel systems).<\/li>\n<\/ol>\n\n\n\n<h2 class=\"wp-block-heading\">Output Structure<\/h2>\n\n\n\n<p>Upon successful execution, the output will include structured data in YAML format (or JSON if specified). The primary components returned are:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><code>main_domain<\/code>: The primary domain of the cPanel account.<\/li>\n\n\n\n<li><code>addon_domains<\/code>: A list of additional domains hosted under the same user.<\/li>\n\n\n\n<li><code>parked_domains<\/code>: Domains pointing to the main domain (aliases).<\/li>\n\n\n\n<li><code>sub_domains<\/code>: Subdomains created under the main or addon domains.<\/li>\n\n\n\n<li><code>status<\/code>: Status code indicating success (1) or failure (0).<\/li>\n\n\n\n<li><code>errors<\/code>, <code>warnings<\/code>, <code>messages<\/code>: Optional fields providing additional context.<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\">Example Output (Truncated for Brevity)<\/h3>\n\n\n\n<pre class=\"wp-block-code\"><code>data:\n  addon_domains:\n    - example1.com\n    - example2.in\n  main_domain: example.com\n  parked_domains: &#091;]\n  sub_domains:\n    - app.example1.com\n    - billing.example2.in\nstatus: 1<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading\">Use Cases<\/h2>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Verifying domain ownership and mappings<\/li>\n\n\n\n<li>Auditing hosted domains under a specific user<\/li>\n\n\n\n<li>Assisting in domain migration or restructuring<\/li>\n\n\n\n<li>Generating reports for support or compliance<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\">Conclusion<\/h2>\n\n\n\n<p>The <code>uapi --user=username DomainInfo list_domains<\/code> command is a reliable method for retrieving detailed domain information for a given cPanel user. It helps administrators efficiently manage multi-domain hosting environments, track configuration changes, and support troubleshooting tasks.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>This document provides details on using the uapi command-line tool to list all domains associated with a specific cPanel user account. The example focuses on retrieving domain information for the user &lt; cpanel username &gt; using the DomainInfo::list_domains function of the Universal API (UAPI). Command Used This command queries and lists all domain-related data for ..<\/p>\n<div class=\"clear-fix\"><\/div>\n<p><a href=\"https:\/\/pheonixsolutions.com\/knowledge-base\/2025\/08\/03\/domain-listing-via-uapi-for-cpanel-user\/\" title=\"read more...\">Read more<\/a><\/p>\n","protected":false},"author":11,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[1],"tags":[],"class_list":["post-2892","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v27.4 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>Domain Listing via UAPI for cPanel User - PheonixSolutions Knowledge-Base<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/pheonixsolutions.com\/knowledge-base\/2025\/08\/03\/domain-listing-via-uapi-for-cpanel-user\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Domain Listing via UAPI for cPanel User - PheonixSolutions Knowledge-Base\" \/>\n<meta property=\"og:description\" content=\"This document provides details on using the uapi command-line tool to list all domains associated with a specific cPanel user account. The example focuses on retrieving domain information for the user &lt; cpanel username &gt; using the DomainInfo::list_domains function of the Universal API (UAPI). Command Used This command queries and lists all domain-related data for ..Read more\" \/>\n<meta property=\"og:url\" content=\"https:\/\/pheonixsolutions.com\/knowledge-base\/2025\/08\/03\/domain-listing-via-uapi-for-cpanel-user\/\" \/>\n<meta property=\"og:site_name\" content=\"PheonixSolutions Knowledge-Base\" \/>\n<meta property=\"article:published_time\" content=\"2025-08-03T15:11:28+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2025-08-03T15:11:32+00:00\" \/>\n<meta name=\"author\" content=\"srisanthosh s\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"srisanthosh s\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/2025\\\/08\\\/03\\\/domain-listing-via-uapi-for-cpanel-user\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/2025\\\/08\\\/03\\\/domain-listing-via-uapi-for-cpanel-user\\\/\"},\"author\":{\"name\":\"srisanthosh s\",\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/#\\\/schema\\\/person\\\/070895e04bc57565b04d6106e4da129c\"},\"headline\":\"Domain Listing via UAPI for cPanel User\",\"datePublished\":\"2025-08-03T15:11:28+00:00\",\"dateModified\":\"2025-08-03T15:11:32+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/2025\\\/08\\\/03\\\/domain-listing-via-uapi-for-cpanel-user\\\/\"},\"wordCount\":254,\"commentCount\":0,\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/2025\\\/08\\\/03\\\/domain-listing-via-uapi-for-cpanel-user\\\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/2025\\\/08\\\/03\\\/domain-listing-via-uapi-for-cpanel-user\\\/\",\"url\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/2025\\\/08\\\/03\\\/domain-listing-via-uapi-for-cpanel-user\\\/\",\"name\":\"Domain Listing via UAPI for cPanel User - PheonixSolutions Knowledge-Base\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/#website\"},\"datePublished\":\"2025-08-03T15:11:28+00:00\",\"dateModified\":\"2025-08-03T15:11:32+00:00\",\"author\":{\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/#\\\/schema\\\/person\\\/070895e04bc57565b04d6106e4da129c\"},\"breadcrumb\":{\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/2025\\\/08\\\/03\\\/domain-listing-via-uapi-for-cpanel-user\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/2025\\\/08\\\/03\\\/domain-listing-via-uapi-for-cpanel-user\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/2025\\\/08\\\/03\\\/domain-listing-via-uapi-for-cpanel-user\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Domain Listing via UAPI for cPanel User\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/#website\",\"url\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/\",\"name\":\"PheonixSolutions Knowledge-Base\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/#\\\/schema\\\/person\\\/070895e04bc57565b04d6106e4da129c\",\"name\":\"srisanthosh s\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/6aaff236b178a614b2cfa9b0388af65e26cb08bb19608a622574904d2765036d?s=96&d=mm&r=g\",\"url\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/6aaff236b178a614b2cfa9b0388af65e26cb08bb19608a622574904d2765036d?s=96&d=mm&r=g\",\"contentUrl\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/6aaff236b178a614b2cfa9b0388af65e26cb08bb19608a622574904d2765036d?s=96&d=mm&r=g\",\"caption\":\"srisanthosh s\"},\"url\":\"https:\\\/\\\/pheonixsolutions.com\\\/knowledge-base\\\/author\\\/srisanthosh\\\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Domain Listing via UAPI for cPanel User - PheonixSolutions Knowledge-Base","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/pheonixsolutions.com\/knowledge-base\/2025\/08\/03\/domain-listing-via-uapi-for-cpanel-user\/","og_locale":"en_US","og_type":"article","og_title":"Domain Listing via UAPI for cPanel User - PheonixSolutions Knowledge-Base","og_description":"This document provides details on using the uapi command-line tool to list all domains associated with a specific cPanel user account. The example focuses on retrieving domain information for the user &lt; cpanel username &gt; using the DomainInfo::list_domains function of the Universal API (UAPI). Command Used This command queries and lists all domain-related data for ..Read more","og_url":"https:\/\/pheonixsolutions.com\/knowledge-base\/2025\/08\/03\/domain-listing-via-uapi-for-cpanel-user\/","og_site_name":"PheonixSolutions Knowledge-Base","article_published_time":"2025-08-03T15:11:28+00:00","article_modified_time":"2025-08-03T15:11:32+00:00","author":"srisanthosh s","twitter_card":"summary_large_image","twitter_misc":{"Written by":"srisanthosh s","Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/pheonixsolutions.com\/knowledge-base\/2025\/08\/03\/domain-listing-via-uapi-for-cpanel-user\/#article","isPartOf":{"@id":"https:\/\/pheonixsolutions.com\/knowledge-base\/2025\/08\/03\/domain-listing-via-uapi-for-cpanel-user\/"},"author":{"name":"srisanthosh s","@id":"https:\/\/pheonixsolutions.com\/knowledge-base\/#\/schema\/person\/070895e04bc57565b04d6106e4da129c"},"headline":"Domain Listing via UAPI for cPanel User","datePublished":"2025-08-03T15:11:28+00:00","dateModified":"2025-08-03T15:11:32+00:00","mainEntityOfPage":{"@id":"https:\/\/pheonixsolutions.com\/knowledge-base\/2025\/08\/03\/domain-listing-via-uapi-for-cpanel-user\/"},"wordCount":254,"commentCount":0,"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/pheonixsolutions.com\/knowledge-base\/2025\/08\/03\/domain-listing-via-uapi-for-cpanel-user\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/pheonixsolutions.com\/knowledge-base\/2025\/08\/03\/domain-listing-via-uapi-for-cpanel-user\/","url":"https:\/\/pheonixsolutions.com\/knowledge-base\/2025\/08\/03\/domain-listing-via-uapi-for-cpanel-user\/","name":"Domain Listing via UAPI for cPanel User - PheonixSolutions Knowledge-Base","isPartOf":{"@id":"https:\/\/pheonixsolutions.com\/knowledge-base\/#website"},"datePublished":"2025-08-03T15:11:28+00:00","dateModified":"2025-08-03T15:11:32+00:00","author":{"@id":"https:\/\/pheonixsolutions.com\/knowledge-base\/#\/schema\/person\/070895e04bc57565b04d6106e4da129c"},"breadcrumb":{"@id":"https:\/\/pheonixsolutions.com\/knowledge-base\/2025\/08\/03\/domain-listing-via-uapi-for-cpanel-user\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/pheonixsolutions.com\/knowledge-base\/2025\/08\/03\/domain-listing-via-uapi-for-cpanel-user\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/pheonixsolutions.com\/knowledge-base\/2025\/08\/03\/domain-listing-via-uapi-for-cpanel-user\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/pheonixsolutions.com\/knowledge-base\/"},{"@type":"ListItem","position":2,"name":"Domain Listing via UAPI for cPanel User"}]},{"@type":"WebSite","@id":"https:\/\/pheonixsolutions.com\/knowledge-base\/#website","url":"https:\/\/pheonixsolutions.com\/knowledge-base\/","name":"PheonixSolutions Knowledge-Base","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/pheonixsolutions.com\/knowledge-base\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/pheonixsolutions.com\/knowledge-base\/#\/schema\/person\/070895e04bc57565b04d6106e4da129c","name":"srisanthosh s","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/6aaff236b178a614b2cfa9b0388af65e26cb08bb19608a622574904d2765036d?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/6aaff236b178a614b2cfa9b0388af65e26cb08bb19608a622574904d2765036d?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/6aaff236b178a614b2cfa9b0388af65e26cb08bb19608a622574904d2765036d?s=96&d=mm&r=g","caption":"srisanthosh s"},"url":"https:\/\/pheonixsolutions.com\/knowledge-base\/author\/srisanthosh\/"}]}},"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/pheonixsolutions.com\/knowledge-base\/wp-json\/wp\/v2\/posts\/2892","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/pheonixsolutions.com\/knowledge-base\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/pheonixsolutions.com\/knowledge-base\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/pheonixsolutions.com\/knowledge-base\/wp-json\/wp\/v2\/users\/11"}],"replies":[{"embeddable":true,"href":"https:\/\/pheonixsolutions.com\/knowledge-base\/wp-json\/wp\/v2\/comments?post=2892"}],"version-history":[{"count":1,"href":"https:\/\/pheonixsolutions.com\/knowledge-base\/wp-json\/wp\/v2\/posts\/2892\/revisions"}],"predecessor-version":[{"id":2893,"href":"https:\/\/pheonixsolutions.com\/knowledge-base\/wp-json\/wp\/v2\/posts\/2892\/revisions\/2893"}],"wp:attachment":[{"href":"https:\/\/pheonixsolutions.com\/knowledge-base\/wp-json\/wp\/v2\/media?parent=2892"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/pheonixsolutions.com\/knowledge-base\/wp-json\/wp\/v2\/categories?post=2892"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/pheonixsolutions.com\/knowledge-base\/wp-json\/wp\/v2\/tags?post=2892"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}