cPanel API 2 Functions - Park::listaddondomains

Description

This function lists the cPanel account's addon 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=Park&cpanel_jsonapi_func=listaddondomains

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// List addon domains.
$listaddondomains $cpanel->api2(
    'Park''listaddondomains'
 
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# List addon domains.
my $listaddondomains $cpliveapi->api2(
    'Park''listaddondomains',
 
);

 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 Park listaddondomains

 

Notes:

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

 Output (JSON)

 

{

 

  "cpanelresult": {

 

    "apiversion": 2,

 

    "func": "listaddondomains",

 

    "data": [

 

      {

 

        "domainkey": "boomer_example.com",

 

        "rootdomain": "example.com",

 

        "status": "not redirected",

 

        "subdomain": "boomer",

 

        "reldir": "home:public_html/boomer.com",

 

        "dir": "/home/example/public_html/boomer.com",

 

        "basedir": "public_html/boomer.com",

 

        "domain": "boomer.com",

 

        "fullsubdomain": "boomer.example.com"

 

      },

 

      {

 

        "domainkey": "sooner_example.com",

 

        "rootdomain": "example.com",

 

        "status": "not redirected",

 

        "subdomain": "sooner",

 

        "reldir": "home:public_html/sooner.com",

 

        "dir": "/home/example/public_html/sooner.com",

 

        "basedir": "public_html/sooner.com",

 

        "domain": "sooner.com",

 

        "fullsubdomain": "sooner.example.com"

 

      }

 

    ],

 

    "event": {

 

      "result": 1

 

    },

 

    "module": "Park"

 

  }

 

}

 

Note:

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

 

Parameters

 Return 

 Type 

Description

 Possible values 

 Example 

 regex

 string 

 A Perl Compatible Regular Expression (PCRE) that filters the results.

 If you do not enter a value for this parameter, the function returns all addon domains that reside on the server. 

 A valid PCRE.

 domain

 

Returns

Return
Type
Description
Possible values
Example
 domainkey
 string
 The addon domain's domain key.
 The cPanel account's username, an underscore (_), and the main domain name.
username_maindomain.com
 domain
 string
 The addon domain's name.
 A valid domain on the account.
addon-example.com
 
 rootdomain
 string
 The cPanel account's main domain.
 A valid domain on the account.
example.com
 status
 string
 Whether the addon domain redirects to another domain.
  • not redirected — The addon domain does notredirect to another domain.
  • redirected — The addon domain redirects to another domain.
not redirected
 fullsubdomain 
 string
 The subdomain that corresponds to the addon domain.
A valid string.
username
 reldir
 string
 The path to the domain's document root.
The relative path to the addon domain's document root.
The function prefaces this value with home:
home:public_html/addon-example.com/
 dir
 string
 The absolute path to the addon domain's document root.
The absolute path to the addon domain's document root.
 /home/user/public_html/addon-example.com 
 basedir
 string
 The directory that contains the addon domain's document root. 
 The path to the addon domain's document root, relative to the cPanel account's home directory. 
The function prefaces this value with home:
public_html/addon-example.com/
 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

   

 
  • 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....