Description

This function fetches zone files that cPanel generated for the account.

Examples 


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

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

 

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

 

cpapi2 --user=username ZoneEdit fetch_cpanel_generated_domains domain=metoo.example.com

{
  "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"
  }
}

Parameters

ReturnTypeDescriptionPossible valuesExample
domainstring

A domain to append to the end of the output.

This value defaults to the cPanel account's main domain.

A valid domain name.metoo.example.com

Returns

Return TypeDescriptionPossible valuesExample
domainstringThe domain's zone file.A valid domain name.example.com
reasonstring

A reason for failure.

This function only returns a reason value if it failed.

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