cPanel API 2 Functions - DomainLookup::countbaseddomains - Knowledgebase

Description

This function retrieves the total number of base domains.

Warning:

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.

Examples

WHM API (JSON)

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

LiveAPI PHP Class

$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'

);

LiveAPI Perl Module

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',

);

cPanel Tag System (deprecated)

Warning:

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 countbasedomains

Notes:

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

 Output (JSON)

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

Note:

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

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
count	integer	The number of base domains. Note: This value includes the main domain, addon domains, and parked domains.	A positive integer.	5
reason	string	A reason for failure. Note: This function only returns a reason value if there was an error.	A string that describes the error.	This is an error message.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories