Child pages
  • cPanel API 2 Functions - ZoneEdit::resetzone
Skip to end of metadata
Go to start of metadata

Description

This function resets a zone file to its original state.


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=resetzone&domain=example.com


Note:

 For more information, read our Calls from the WHM API documentation.

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Add a type "A" zone record to "example.com"
$reset_zone = $cpanel->api2(
    'ZoneEdit', 'resetzone',
 array(
        'domain' => 'example.com',
  ) 
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Add a type "A" Zone Record to "example.com"
my $reset_zone= $cpliveapi->api2(
    'ZoneEdit', 'resetzone',
{ 
        'domain' => 'example.com',
  }
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Tag System (deprecated)


Warnings:

  • 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. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • 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 documentation.

 Command Line
cpapi2 --user=username ZoneEdit resetzone domain=example.com


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:

    /usr/local/cpanel/bin/cpapi2

 Output (JSON)
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "resetzone",
    "data": [
      {
        "result": {
          "statusmsg": "",
          "status": 1,
          "checkmx": {
            "warnings": [
              
            ],
            "issecondary": 0,
            "local": 0,
            "detected": "remote",
            "remote": 1,
            "isprimary": 0,
            "changed": 1,
            "secondary": 0,
            "mxcheck": "auto"
          }
        }
      }
    ],
    "event": {
      "result": 1
    },
    "module": "ZoneEdit"
  }
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParametersTypeDescriptionPossible valuesExample
domainstring

Required

The record's domain.

A valid domain name.example.com

Returns

Return TypeDescriptionPossible valuesExample
resulthashA hash of the function's results.A hash that contains the statusmsg and status returns. 

statusmsg

string

A status message from the DNS server.

The function returns this value in the result hash.

A string.
 Click to view...
Bind reloading on hostname using rndc zone: [example.com]\n

checkmx

hash

A hash of the mail exchanger's returns.

The function returns this value in the result hash.

A hash that contains the issecondarylocal, detected, remote, isprimary, changed, secondary, and mxcheck return. 

issecondary

Boolean

Whether the domain's mail exchanger is the secondary exchanger.

The function returns this value in the checkmx hash.

  • 1 — Secondary exchanger.
  • 0Not a secondary exchanger.
0

local

Boolean

Whether the recently-deleted mail exchanger was a local exchanger.

The function returns this value in the checkmx hash.

  • 1 — Local exchanger.
  • 0Not a local exchanger.
0

detected

string

This return is identical to the mxcheck parameter.

The function returns this value in the checkmx hash.

A valid string.remote

remote

Boolean

Whether the recently-deleted mail exchanger was a remote exchanger.

The function returns this value in the checkmx hash.

  • 1 — Remote exchanger.
  • 0Not a remote exchanger.
1

isprimary

Boolean

Whether the domain is the account's primary domain.

The function returns this value in the checkmx hash.

  • 1 — Primary domain.
  • 0Not the primary domain.
0

changed

Boolean

Whether a change has occurred.

The function returns this value in the checkmx hash.

  • 1 — Changes.
  • 0No changes.
1

secondary

Boolean

Whether the recently-deleted mail exchanger was a secondary exchanger.

The function returns this value in the checkmx hash.

  • 1 — Secondary exchanger.
  • 0Not a secondary exchanger.
0

mxcheck

string

The type of mail exchanger that was recently deleted.

The function returns this value in the checkmx hash.

  • local
  • remote
  • secondary
  • auto
auto
reasonstring

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.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1