cPanel API 2 Functions - ZoneEdit::remove_zone_record

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function removes a zone record.

Warnings:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.
When you disable the DNS role , 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 interface (WHM >> Home >> Packages >> Feature Manager):

Ability to Change MX
Zone Editor (AAAA, CAA, SRV, TXT)

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=remove_zone_record&domain=example.com&line=42

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.

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

LiveAPI Perl Module

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.

cPanel Tag System (deprecated)

Warnings:

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 remove_zone_record domain=example.com line=42

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

Parameters

Parameters Type Description Possible values Example

Parameters	Type	Description	Possible values	Example
`domain`	string	Required The record's domain.	A valid domain name.	`example.com`
`line`	integer	Required The line of the record.	A positive integer.	`42`

domain

string

Required

The record's domain.

A valid domain name.

example.com

line

integer

Required

The line of the record.

A positive integer.

42

Returns

Return	Type	Description	Possible values	Example
`result`	hash	A hash that contains the results of the change to the nameserver.	This hash includes the `newserial`, `statusmsg`, and `status` returns.
`newserial`	integer	The new serial number of the zone file. The function returns this value in the `result` hash.	A positive integer.	`2014101603`
`statusmsg`	string	A status message from the DNS server. The function returns this value in the `result` hash.	A string.	`Bind reloading on hostname using rndc zone: [example.com]\n`
`status`	string	Whether the function succeeded. The function returns this value in the `result` hash.	`1` — The function succeeded. `0` — The function failed.	`1`
`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`