# cPanel API 2 Functions - ZoneEdit::fetch_cpanel_generated_domains

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 fetches zone files that cPanel generated for the account.

Warning:
We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists.

## 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=ZoneEdit&cpanel_jsonapi_func=fetch_cpanel_generated_domains
```

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.

// Fetch all cPanel-generated domains for the account.
$fetch_domains = $cpanel->api2(
    'ZoneEdit', 'fetch_cpanel_generated_domains'
);
```

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.

# Fetch all cPanel-generated domains for the account.
my $fetch_domains = $cpliveapi->api2(
    'ZoneEdit', 'fetch_cpanel_generated_domains',
);
```

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 ZoneEdit fetch_cpanel_generated_domains domain=metoo.example.com
```

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": "fetch_cpanel_generated_domains",
    "data": [
      {
        "domain": ""
      },
      {
        "domain": "webdisk.example.com."
      },
      {
        "domain": "mail.example.com."
      },
      {
        "domain": "www.example.com."
      },
      {
        "domain": "ftp.example.com."
      },
      {
        "domain": "default._domainkey.fish.example.com."
      },
      {
        "domain": "example.com."
      },
      {
        "domain": "fish.example.com."
      },
      {
        "domain": "webmail.example.com."
      },
      {
        "domain": "whm.example.com."
      },
      {
        "domain": "localhost.example.com."
      },
      {
        "domain": "default._domainkey.example.com."
      },
      {
        "domain": "cpanel.example.com."
      },
      {
        "domain": "www.fish.example.com."
      }
    ],
    "event": {
      "result": 1
    },
    "module": "ZoneEdit"
  }
}
```

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
Return
th
Type
th
Description
th
Possible values
th
Example
tbody
tr
td
code
domain
td
em
string
td
p
A domain to append to the end of the output.
p
This value defaults to the cPanel account's main domain.
td
A valid domain name.
td
code
metoo.example.com
## Returns

table
colgroup
col
col
col
col
col
thead
tr
th
strong
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
domain
td
em
string
td
The domain's zone file.
td
A valid domain name.
td
code
example.com
tr
td
code
reason
td
em
string
td
p
A reason for failure.
p
div
Note:
p
p
This function only returns a 
code
reason
 value if it failed.
br
td
p
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