Child pages
  • cPanel API 2 Functions - DomainLookup::countbaseddomains

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function retrieves the total number of base domains.


Warning
titleWarning:

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

  • DomainInfo::list_domains

    Excerpt Include
    DD:UAPI Functions - DomainInfo::list_domainsDD:
    UAPI Functions - DomainInfo::list_domains
    nopaneltrue


Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleWHM API (JSON)


Code Block
languagetext
https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=DomainLookup&cpanel_jsonapi_func=countbasedomains

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Count the number of base domains for this account.
$count_base_rdomains = $cpanel->api2(
    'DomainLookup', 'countbaseddomains'
	
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Retrieve document root file paths for all domains.
my $count_base_domains = $cpliveapi->api2(
	'DomainLookup', 'countbaseddomains',

  );

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning


Expand
titleCommand Line


Code Block
languagebash
cpapi2 --user=username DomainLookup countbasedomains

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "countbaseddomains",
    "data": [
      {
        "count": 5
      }
    ],
    "event": {
      "result": 1
    },
    "module": "DomainLookup"
  }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
countinteger

The number of base domains.


A positive integer.

Note
titleNote:

This value includes the main domain, addon domains, and parked domains (aliases).


5
reasonstring

A reason for failure.

Note
titleNote:

This function only returns a reason value if there was an error. 


A string that describes the error. This is an error message.
resultBoolean

Whether the function succeeded.

 

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