Child pages
  • cPanel API 2 Functions - ZoneEdit::fetch_cpanel_generated_domains

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

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

Include Page
LIB:_cPanelAPI2NoEquivalent
LIB:_cPanelAPI2NoEquivalent

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleWHM API (JSON)
Code Block
languagetext
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

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink

Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$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'
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
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',
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning

Expand
titleCommand Line
Code Block
languagebash
cpapi2 --user=username ZoneEdit fetch_cpanel_generated_domains domain=metoo.example.com

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "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"
  }
}

Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote

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.

Note
titleNote:

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