WHM API 1 Functions - editzonerecord

Run the dumpzone function on the DNS zone record to edit.
Locate the Line value that corresponds to the data to edit.
Use the values from that zone record to formulate the appropriate editzonerecord parameters.

Important:

When you call this function, you must include the additional parameters for the selected zone record type.
To change the zone record's IP address, we recommend that you use the swapip utility or the setsiteip function instead.
You cannot edit other DNS zones that reside on Write-only servers in a DNS cluster.

Note:

On servers that run CentOS 7, you may see a named warning about the absence of SPF resource records on DNS.

This warning is not relevant on CentOS 7 servers, because RFC 7208 deprecated SPF records. CentOS 7 servers use TXT records instead of SPF records.
Red Hat 7.1 and CentOS 7.1 both contain bind-9.9.4-23.el7, which is an updated version of BIND that complies with RFC 7208. To resolve this issue, update your operating system to a version that contains the updated version of BIND. For more information, read the Red Hat Bugzilla case about SPF record errors.

Important:

In cPanel & WHM version 76 and later, when you disable the DNS role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples

JSON API

https://hostname.example.com:2087/cpsess##########/json-api/editzonerecord?api.version=1&domain=example.com&line=24&name=hostname.example.com.&class=IN&ttl=86400&type=A&address=192.168.0.20

XML API

https://hostname.example.com:2087/cpsess##########/xml-api/editzonerecord?api.version=1&domain=example.com&line=24&name=hostname.example.com.&class=IN&ttl=86400&type=A&address=192.168.0.20

Command Line

whmapi1 editzonerecord domain=example.com line=24 name=hostname.example.com. class=IN ttl=86400 type=A address=192.168.0.20 txtdata="v%3Dspf1%20ip4%3A208.74.121.106%20%2Ba%20%2Bmx%20%2Bip4%3A10.1.198.15%20~all"

Notes:

Unless otherwise noted, you must URI-encode values.
For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
If you run CloudLinux™, you must use the full path of the whmapi1 command:
```
/usr/local/cpanel/bin/whmapi1
```

Output (JSON)

{
  "metadata": {
    "version": 1,
    "reason": "Bind reloading on hostname using rndc zone: [example.com]\n",
    "result": 1,
    "command": "editzonerecord"
  }
}

Output (XML)

<result>
    <metadata>
        <version>1</version>
        <reason>
            Bind reloading on hostname using rndc zone: [example.com]
        </reason>
        <result>1</result>
        <command>editzonerecord</command>
    </metadata>
</result>

Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

Parameter	Type	Description	Possible values	Example
`domain`	string	Required The zone record's domain.	A valid domain name on the server.	`example.com`
`line`	integer	Required The zone record's file line number.	A positive integer that represents a line number in the domain's DNS zone file.	`24`
`name`	string	Required The record's name.	A valid domain name or hostname. Note: Do not omit any necessary trailing periods.	`hostname.example.com.`
`class`	string	Required The record's class.	IN Very rarely, another valid DNS record class.	`IN`
`ttl`	integer	Required The record's Time To Live (TTL).	A positive integer that represents the TTL, in seconds.	`86400`
`type`	string	Required The DNS record type.	Warning: The DNS record type determines the additional DNS zone record parameters that you must include. `A` — A records store IPv4 addresses. Use them to map a hostname to an IPv4 address. `A6` — A6 records store IPv6 addresses. Note: A6 records are deprecated . We strongly recommend that you use AAAA records to store IPv6 addresses. `AAAA` — AAAA records store IPv6 addresses. `ASFDB` — ASFDB records store the location of an AFS cell's database servers. `CAA` — CAA records control which certificate authorities can issue SSL certificates for a domain. Note: We added this DNS record type in cPanel & WHM version 66. `CNAME` — CNAME records create an alias to another hostname. `DNAME` — DNAME records create an alias for a hostname and its subnames. `DS` — DS records specify a record's delegation signer. `HINFO` — HINFO records specify a host's CPU and OS types. `LOC` — LOC records store a hostname's geographical location. `MX` — MX records point a domain name to its MTAs. `NS` — NS records store a domain's authoritative nameservers. `PTR` — PTR records point to a CNAME. `RP` — RP records store a domain's Responsible Person's information. `SOA` — SOA records designate the beginning of a zone of authority. `SRV` — SRV records store the service location records for newer protocols (for example, Autodiscover). `SSHFP` — SSHFP records store a domain's SSH public host key's fingerprint. Warning: We do not currently support this DNS record type. `TXT` — TXT records store descriptive text or useful records (for example, SPF or DKIM records).	`A`

A Record Parameters

Click to view...

Parameter	Type	Description	Possible values	Example
`address`	string	The zone record's IPv4 address.	A valid IPv4 address.	`192.168.0.20`

Note:

For more information about A records, read RFC 1035 at IANA.

A6 Record Parameters

Click to view...

Important:

A6 records are deprecated. We strongly recommend that you use AAAA records to store IPv6 addresses.

Parameter	Type	Description	Possible values	Example
`prefix`	string	The record's prefix length.	A positive integer.	`48`
`refer`	string	The record's address suffix.	A valid IPv6 address suffix. Note You must uuencode the colons (`:`) in IPv6 addresses in your function calls.	`0::0`

AAAA Record Parameters

Click to view...

Parameter	Type	Description	Possible values	Example
`address`	string	The zone record's IPv6 address.	A valid IPv6 address. Note You must uuencode the colons (`:`) in IPv6 addresses in your function calls.	`2001:1:42:1::2a`

Note:

For more information about AAAA records, read RFC 3596 at IANA .

AFSDB Record Parameters

Click to view...

Parameter Type Description Possible values Example

subtype

integer

The AFS cell type.

A 16-bit integer that represents the type of AFS cell.

For example, specify 1 to signify an AFS version 3.0 Volume Location Server.

1

hostname string The database servers' hostname. A valid hostname. afs.example.com

Note:

For more information about ASFDB records, read RFC 1183 at IANA.

CAA Record Parameters

Click to view...

Note:

We added these parameters in cPanel & WHM version 66.

Parameter Type Description Possible values Example

flag

integer

Required

Whether the Certificate Authority (CA) will issue an SSL certificate if the CAA resource record contains unknown property tags.

For more information about CAA record flags and property tags, read the RFC 6844 documentation.

0 — Non-critical. If the CAA Resource Record contains unknown property tags, the CA will issue an SSL certificate.
1 — Critical. If the CAA Resource Record contains unknown property tags, the CA will not issue an SSL certificate.

0

tag

string

Required

The CAA record's property type.

issue — Authorize a CA to issue a certificate for the domain.
issuewild — Authorize a CA to issue a wildcard certificate for the domain.
iodef — Specify a URL to which a CA may report policy violations.

issue

value

string

Required

The CA's domain or URL.

Note:

If you use iodef as the tag parameter's value, enter a URL that a CA can use to report issues as this parameter's value i

A valid SSL provider.
A mailto URL or a standard URL.

totallyrealca.tld

CNAME Record Parameters

Click to view...

Parameter Type Description Possible values Example

cname string The canonical name (CNAME) alias. A valid alias. sydneybristow.example.com

flatten

Boolean

Whether to resolve the specified CNAME value with the record's IP address.

If you do not also set the flatten_to parameter, the system will attempt to resolve the CNAME automatically.

Note:

Only use this parameter when you alter the zone's root record.

1 — Flattened.
0 — Not flattened (the function will fail).

1

flatten_to

string

The IP address that the specified CNAME will resolve to.

You must use the flatten parameter with this parameter.

A valid IPv4 or IPv6 address.

192.168.0.20

Note:

For more information about CNAME records, read RFC 1035 at IANA .

DNAME Record Parameters

Click to view...

Parameter	Type	Description	Possible values	Example
`dname`	string	The delegation name (DNAME) alias.	A valid alias.	`hostname.dev.example.com`

Note:

For more information about DNAME records, read RFC 2672 at IANA.

DS Record Parameters

Click to view...

Parameter	Type	Description	Possible values	Example
`keyname`	integer	The record's KeyTag value.	An unsigned decimal integer.	`2642`
`algorithm`	integer	The record's algorithm number.	`1` — RSAMD5 `2` — Diffie-Hellman `3` — DSA/SHA-1 `4` — Elliptic Curve `5` — RSA/SHA-1 `252` — Indirect `253` — Private DNS `254` — Private OID	5
`digitype`	integer	The record's digest type.	1 — SHA-1	1

Note:

For more information about DS records, read RFC 4034 at IANA.

HINFO Record Parameters

Click to view...

Parameter	Type	Description	Possible values	Example
`cpu`	string	The host's CPU type.	A valid CPU type.	`INTEL-386`
`os`	string	The host's operating system.	A valid operating system.	`UNIX`

Note:

For more information about HINFO records, read RFC 1700 at IANA.

LOC Record Parameters

Click to view...

Parameter	Type	Description	Possible values	Example
`version`	integer	The record's version number.	You must set this value to `0`.	`0`
`size`	integer	The diameter of a sphere that encloses the entire location.	A positive integer that represents a diameter, in meters.	`10`
`horiz_pre`	integer	The location's horizontal precision.	A positive integer that represents a distance, in meters.	`10`
`vert_pre`	integer	The location's vertical precision.	A positive integer that represents a distance, in meters.	`10`
`latitude`	string	The location's latitude.	A valid latitude.	`41 51 54.305 N`
`longitude`	string	The location's longitude.	A valid longitude.	`87 36 47.95 W`
`altitude`	string	The location's altitude.	The location's altitude above sea level, in meters. Note: Make certain that you append `m` to the altitude value.	`178m`

Note:

For more information about LOC records, read RFC 1876 at IANA .

MX Record Parameters

Click to view...

Parameter	Type	Description	Possible values	Example
`preference`	integer	The record's preference.	An integer that represents the record's priority order. Note: Lower values have a higher priority order.	`10`
`exchange`	string	The server's location's canonical name (CNAME).	A valid CNAME.	`mail.example.com`

Note:

For more information about MX records, read RFC 1035 at IANA.

NS Record Parameters

Click to view...

Parameter	Type	Description	Possible values	Example
`nsdname`	string	The domain's authoritative nameserver.	A valid nameserver.	`ns1.example.com`

Note:

For more information about NS records, read RFC 1035 at IANA.

PTR Record Parameters

Click to view...

Parameter	Type	Description	Possible values	Example
`ptrdname`	string	A pointer to a canonical name (CNAME).	A valid hostname. Note: Do not omit any necessary trailing periods.	`hostname.example.com.`

Note:

For more information about PTR records, read RFC 1035 at IANA.

RP Record Parameters

Click to view...

Parameter	Type	Description	Possible values	Example
`mbox`	string	The Responsible Person's (RP's) email address.	A valid email address. Note: Replace the `@` symbol with a period (`.`). Do not omit any necessary trailing periods.	user.example.com.
`txtdname`	string	The RP's domain name.	A valid hostname. Note: Do not omit any necessary trailing periods.	`mx1.host.example.com.`

Note:

For more information about RP records, read RFC 1183 at IANA.

SOA Record Parameters

Click to view...

Parameter	Type	Description	Possible values	Example
`serial`	integer	The zone file's revision number.	A valid revision number.	`2013122501`
mname	string	The domain's authoritative nameserver.	A valid nameserver.	`ns1.example.com`
`retry`	integer	The amount of time to wait before the secondary server retries a failed zone transfer.	A positive integer that represents an amount of time, in seconds.	`1440`
`refresh`	string	The amount of time to wait before the secondary DNS server queries the primary DNS server's SOA records for changes.	A positive integer that represents an amount of time, in seconds.	`1440`
`Lines`	string	The number of lines in the SOA section.	A positive integer that represents a number of lines.	`4`
`expire`	string	The amount of time to wait before the secondary server attempts to complete a zone transfer.	A positive integer that represents an amount of time, in seconds.	`3600000`
`rname`	string	The Responsible Person's (RP's) email address.	A valid email address. Note: Replace the `@` symbol with a period (`.`). Do not omit any necessary trailing periods.	`user.example.com.`

Note:

For more information about SOA records, read RFC 1035 at IANA.

SRV Record Parameters

Click to view...

Parameter	Type	Description	Possible values	Example
`priority`	integer	The target host's preference.	An integer that represents the target host's priority order. Note: Lower numbers have a higher priority order.	`0`
`weight`	integer	A relative weight. The system uses this value to rank entries with the same `priority` value.	An integer that represents the target host's weight against other hosts with the same `priority` value.	`2`
`port`	integer	The target host's port.	A valid port number.	`389`
`target`	string	The service's target host.	A valid hostname.	`service.example.com`

Note:

For more information about SRV records, read RFC 2782 at IANA.

SSHFP Record Parameters

Click to view...

Warning:

We do not currently support this DNS record type.

Parameter Type Description Possible values Example

algorithm

string

The public key's algorithm number.

1 — RSA
2 — DSS

1

fptype

string

The public key's fingerprint type.

1 — SHA-1

1

Note:

For more information about SSHFP records, read RFC 4255 at IANA.

TXT Record Parameters

Click to view...

Parameter	Type	Description	Possible values	Example
`txtdata`	string	The TXT record's data.	A valid TXT record. Note: This value must include beginning and ending quotes (""). Do not URI-encode the quotes.	`"v=spf1 a -all"`

Note:

For more information about TXT records, read RFC 1464 at IANA.

Returns

This function only returns metadata.

Function information

API Version:

WHM API 1

Available in:

WHM 11+

Methods:

GET, POST

Required Parameters:

domain, line, name, class, ttl, type

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

Some functions and parameters may require that you authenticate as the root user.
You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.

Find a function

Related functions

Page:

WHM API 1 Functions - lookupnsip — This function retrieves a nameserver's IP address.
Page:

WHM API 1 Functions - setresolvers — This function configures the server's resolver nameservers.
Page:

WHM API 1 Functions - resolvedomainname — This function resolves a domain's IP address.
Page:

WHM API 1 Functions - lookupnsips — This function retrieves a nameserver's IPv4 and IPv6 addresses.
Page:

WHM API 1 Sections - DNS — DNS functions allow you to manage your server's DNS zones and records.

Child pages

WHM API 1 Functions - editzonerecord

Description

Examples

Parameters

A Record Parameters

A6 Record Parameters

AAAA Record Parameters

AFSDB Record Parameters

CAA Record Parameters

CNAME Record Parameters

DNAME Record Parameters

DS Record Parameters

HINFO Record Parameters

LOC Record Parameters

MX Record Parameters

NS Record Parameters

PTR Record Parameters

RP Record Parameters

SOA Record Parameters

SRV Record Parameters

SSHFP Record Parameters

TXT Record Parameters

Returns

Function information

About WHM API 1

Find a function

Related functions