Edit Zone Record — editzonerecord

This function is only available in WHM 11.25 and later.

This function allows you to edit a DNS zone record on the server.

To use this function most effectively, you should first run the dumpzone function for the domain(s) whose record(s) you wish to edit. The output of that function call will be used as a reference to create the input for this function.

1. In the output of the dumpzone function, locate the Line variable corresponding to the data you wish to edit.
2. Next, locate the parameter(s) you wish to edit. Example: ttl
3. Use the domain name, line, and new parameter value to formulate the editzonerecord function call as detailed below.

Note: If you wish to change only the IP in a zone record, the swapip script may suit your purposes better.

Calling Functions

Using the XML API

Using the JSON API

Variables

Input

The folliowing input variables are required:

• domain (string) — The domain name whose zone record you wish to edit.
• Line (string) — The number of the zone record line you wish to edit.

The following input variables represent parameters to be edited and are optional:

• address (string) — IP address. Example: 127.0.0.1
  Note: If you wish to change only the IP in a zone record, the swapip script may suit your purposes better.
• class (string) — The class of the record.
  • Note: This value is typically IN, for "Internet."
• cname (string) — The canonical name in a CNAME record.
• exchange (string) — In an MX record, the name of the destination mail server.
• preference (integer) — In an MX record, the priority of the destination mail server.
  • Note: 0 is the highest priority.
• expire (string) — A 32-bit time value that specifies the upper limit on the time interval that can elapse before the zone is no longer authoritative.
• minimum (integer) — The unsigned 32-bit minimum time to live field that should be exported with any record from this zone.
• mname (integer) — The domain name of the nameserver serving as the original or primary source of data for this zone. Example: ns1.example.com
• name (string) — Domain name. Example: example.com
• nsdname (string) — A domain name which specifies a host which should be authoritative for the specified class and domain. Example: ns1.example.com
• raw (string) — Raw line data.
• refresh (integer) — 32-bit time interval which will elapse before the zone will be refreshed.
• retry (integer) — 32-bit time interval which will elapse before a failed refresh will be retried.
• rname (string) — A domain name which specifies the mailbox of the person responsible for this zone. Example: user.example.com
  • Note: Enter this value as user.example.com rather than user@example.com
• serial (integer) — The unsigned 32-bit version number of the original copy of the zone.
• ttl (integer) — The record's time to live.
• type (string) — The DNS record type. Example: NS, SOA, A, etc.
• txtdata (string) — Text record data.

Common record types and associated input variables

For your reference when assembling the edited zone record, here are 4 common record types and their associated input variables.

Output

Examples

XML API

<editzonerecord>
     <result>
            <status>1</status>
            <statusmsg>Wrote zone file.</statusmsg>
      </result>
</editzonerecord>

JSON API

{
   "result":[
      {
         "status":1,
         "statusmsg":"Wrote zone file."
      }
   ]
}