# cPanel API 2 Functions - Park::listaddondomains

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

This function lists the cPanel account's addon domains.

Warning:
We **strongly** recommend that you use the following [UAPI](/cpanel/introduction/) function instead of this function: - [`DomainInfo::list_domains`](https://api.docs.cpanel.net/openapi/cpanel/operation/list_domains/) — This function lists the cPanel account's domains.

## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
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
```

Note:
For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// List addon domains.
$listaddondomains = $cpanel->api2(
    'Park', 'listaddondomains'

);
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


```undefined syntaxhighlighter-pre
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# List addon domains.
my $listaddondomains = $cpliveapi->api2(
    'Park', 'listaddondomains',

);
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) system to call the cPanel APIs. Examples are **only** present in order to help developers move from the old cPanel tag system to our [LiveAPI](/guides/guide-to-the-liveapi-system).
- cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
- For more information, read our [Deprecated cPanel Tag Usage](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username Park listaddondomains
```

div
Notes:

- You **must** URI-encode values.
- `username` represents your account-level username.
- You **must** include the `--user=username` option.
- For more information and additional output options, read our [Guide to cPanel API 2](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the
`cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
{
  "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](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

table
colgroup
col
col
col
col
col
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
regex
td
em
string
td
p
A 
a
Perl Compatible Regular Expression (PCRE)
 that filters the results.
p
If you do 
strong
not
 enter a value for this parameter, the function returns 
strong
all
 addon domains that reside on the server.
td
p
A valid PCRE.
td
code
domain
## Returns

table
colgroup
col
col
col
col
col
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
domainkey
td
em
string
td
The addon domain's domain key.
td
The cPanel account's username, an underscore (
code
_
), and the main domain name.
td
code
username_maindomain.com
tr
td
code
domain
td
em
string
td
p
The addon domain's name.
td
p
A valid domain on the account.
td
code
addon-example.com
tr
td
code
rootdomain
td
em
string
td
The cPanel account's main domain.
td
span
A valid domain on the account.
td
code
example.com
tr
td
code
status
td
em
string
td
p
Whether the addon domain redirects to another domain.
td
ul
li
code
not redirected
 — The addon domain does 
strong
not
 redirect to another domain.
li
code
redirected
 — The addon domain redirects to another domain.
td
code
not redirected
tr
td
code
fullsubdomain
td
em
string
td
The subdomain that corresponds to the addon domain.
td
A valid string.
td
code
username
tr
td
code
reldir
td
em
string
td
The path to the domain's document root.
td
p
The relative path to the addon domain's document root.
p
The function prefaces this value with 
code
home:
td
code
home:public_html/addon-example.com/
tr
td
code
dir
td
em
string
td
The absolute path to the addon domain's document root.
td
The absolute path to the addon domain's document root.
td
code
/home/user/public_html/addon-example.com
tr
td
code
basedir
td
em
string
td
The directory that contains the addon domain's document root.
td
p
The path to the addon domain's document root, relative to the cPanel account's home directory.
p
The function prefaces this value with 
code
home:
td
code
public_html/addon-example.com/
tr
td
code
reason
td
em
string
td
p
A reason for failure
p
Note: This function only returns a 
code
reason
 value if there was an error.
br
td
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1