# cPanel API 2 Functions - ZoneEdit::resetzone 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 resets a zone file to its original state. 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=resetzone&domain=example.com ``` 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. // 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](/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. # 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](/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 resetzone domain=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": "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](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls. ## Parameters table thead tr th Parameters th strong Type th strong Description th strong Possible values th strong Example tbody tr td code domain td em string td p strong Required p The record's domain. td A valid domain name. td code example.com ## Returns table thead tr th strong strong Return th strong Type th strong Description th strong Possible values th strong Example tbody tr td code result td em hash td A hash of the function's results. td A hash that contains the code statusmsg and code status returns. td br tr td p code statusmsg td em string td p A status message from the DNS server. p The function returns this value in the code result hash. td A string. td code Bind reloading on hostname using rndc zone: [example.com]\n tr td p code checkmx td em hash td p A hash of the mail exchanger's returns. p The function returns this value in the code result hash. td A hash that contains the code issecondary , code local , code detected , code remote , code isprimary , code changed , code secondary , and code mxcheck return. td br tr td p code issecondary td em Boolean td p Whether the domain's mail exchanger is the secondary exchanger. p The function returns this value in the code checkmx hash. td ul li code 1 — Secondary exchanger. li code 0 — strong Not a secondary exchanger. td code 0 tr td p code local td em Boolean td p Whether the recently-deleted mail exchanger was a local exchanger. p The function returns this value in the code checkmx hash. td ul li code 1 — Local exchanger. li code 0 — strong Not a local exchanger. td code 0 tr td p code detected td em string td p This return is identical to the code mxcheck parameter. p The function returns this value in the code checkmx hash. td A valid string. td code remote tr td p code remote td em Boolean td p Whether the recently-deleted mail exchanger was a remote exchanger. p The function returns this value in the code checkmx hash. td ul li code 1 — Remote exchanger. li code 0 — strong Not a remote exchanger. td code 1 tr td p code isprimary td em Boolean td p Whether the domain is the account's primary domain. p The function returns this value in the code checkmx hash. td ul li code 1 — Primary domain. li code 0 — strong Not the primary domain. td code 0 tr td p code changed td em Boolean td p Whether a change has occurred. p The function returns this value in the code checkmx hash. td ul li code 1 — Changes. li code 0 — strong No changes. td code 1 tr td p code secondary td em Boolean td p Whether the recently-deleted mail exchanger was a secondary exchanger. p The function returns this value in the code checkmx hash. td ul li code 1 — Secondary exchanger. li code 0 — strong Not a secondary exchanger. td code 0 tr td p code mxcheck td em string td p The type of mail exchanger that was recently deleted. p The function returns this value in the code checkmx hash. td ul li code local li code remote li code secondary li code auto td code auto 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