# cPanel API 2 Functions - ZoneEdit::remove_zone_record 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 removes a zone record. Warnings: * We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists. * When you disable the [*DNS* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function. Note: This function can **only** remove AAAA, MX, and SRV records if the cPanel account's hosting provider enables the following settings in WHM's *[Feature Manager](https://docs.cpanel.net/whm/packages/feature-manager/)* interface (*WHM >>* *Home >> Packages >> Feature Manager*): * *Ability to Change MX* * *Zone Editor (AAAA, CAA, SRV, TXT)* ## 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=remove_zone_record&domain=example.com&line=42 ``` 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. // Remove line "42" from "example.com" $remove_zone_record = $cpanel->api2( 'ZoneEdit', 'remove_zone_record', array( 'domain' => 'example.com', 'line' => '42', ) ); ``` 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. # Remove line "42" from "example.com" my $remove_zone_record = $cpliveapi->api2( 'ZoneEdit', 'remove_zone_record', { 'domain' => 'example.com', 'line' => '42', } ); ``` 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 remove_zone_record domain=example.com line=42 ``` 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": "remove_zone_record", "data": [ { "result": { "newserial": 2014101608, "statusmsg": "Bind reloading on hostname using rndc zone: [example.com]\n", "status": 1 } } ], "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 tr td code line td em integer td p strong Required p The line of the record. td A positive integer. td code 42 ## 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 that contains the results of the change to the nameserver. td This hash includes the code newserial , code statusmsg , and code status returns. td br tr td p code newserial td em integer td p The new serial number of the zone file. p The function returns this value in the code result hash. td A positive integer. td code 2014101603 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 status td em string td p Whether the function succeeded. p The function returns this value in the code result hash. td ul li code 1 — The function succeeded. li code 0 — The function failed. td code 1 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