cPanel API 2 Functions - ZoneEdit::fetch_cpanel_generated_domains - Knowledgebase

Description

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

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples

WHM API (JSON)

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

LiveAPI PHP Class

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

);

LiveAPI Perl Module

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

);

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

Notes:

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

 Output (JSON)

{
  "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 interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Return	Type	Description	Possible values	Example
domain	string	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

Return

Type

Description

Possible values

Example

domain

string

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	Type	Description	Possible values	Example
domain	string	The domain's zone file.	A valid domain name.	example.com
reason	string	A reason for failure. Note: This function only returns a reason value if it failed.	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

Knowledgebase

Categories

Categories