cPanel API 2 Functions - DomainLookup::getbasedomains


This function lists parked domains, addon domains, and main domains.


We strongly recommend that you use the following UAPI function instead of this function:

  • DomainInfo::list_domains — This function lists the cPanel account's domains.



 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
// Retrieve all domains associated with
$get__base_domains $cpanel->api2(

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
# Retrieve all domains associated with
my $get_base_domains $cpliveapi->api2(

 cPanel Tag System (deprecated)


In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.


 Command Line

cpapi2 --user=username DomainLookup getbasedomains



  • You must URI-encode values.
  • username represents your account-level username.

 Output (JSON)

  "cpanelresult": {
    "apiversion": 2,
    "func": "getbasedomains",
    "data": [
        "domain": ","
    "event": {
      "result": 1
    "module": "DomainLookup"


Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.



This function does not accept parameters.





Possible values




 A list of the account's domains.

 A comma-separated list of domains on the account., 



 A reason for failure.



 This function only returns a reasonvalue if there was an error. 



 A string that describes the error. 

 This is an error message.



 Whether the function succeeded.


  • 1 — The function succeeded.
  • 0 — The function failed.



  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....