Page History

Include Page

	LIB:_WHMAPI1Menu
	LIB:_WHMAPI1Menu

Description

Excerpt
This function edits a DNS zone record.

To effectively use this function, use the following workflow:

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.

Warning

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

Include Page

	LIB:_SPFC7Note
	LIB:_SPFC7Note

Multiexcerpt include

SpaceWithExcerpt	com.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptName	APIDisabledDNSRole
PageWithExcerpt	LIB:_ServerRoleDisabledAPI

Panel

bgColor	#F2F2F2
borderStyle	none

Examples

Panel

bgColor	#FFFFFF
borderStyle	none

Expand

title	JSON API

Code Block

language	xml

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

Expand

title	XML API

Code Block

language	xml

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

Expand

title	Command Line

Code Block

language	bash

whmapi1 editzonerecord domain=example.com line=24 name=hostname.example.com. class=IN ttl=86400 type=A address=192.168.0.20

Include Page

	LIB:_WHMAPI1CLINote
	LIB:_WHMAPI1CLINote

Expand

title	Output (JSON)

Code Block

language	text
linenumbers	true

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

Expand

title	Output (XML)

Code Block

language	text
linenumbers	true

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

Include Page

	LIB:_WHMAPIShellNote
	LIB:_WHMAPIShellNote

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

title	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

title	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
title 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
title 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
title 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

Include Page

	LIB:_DNSZoneRecordParameterInclude
	LIB:_DNSZoneRecordParameterInclude

Returns

This function only returns metadata.

Panel

bgColor	#F2F2F2
borderStyle	none

Function information

Panel

bgColor	#FFFFFF
borderStyle	none

Section

Column

width	40%

API Version:

Column
WHM API 1

Section

Column

width	40%

Available in:

Column
WHM 11+

Section

Column

width	40%

Methods:

Column
GET, POST

Section

Column

width	40%

Required Parameters:

Column
`domain`, `line`, `name`, `class`, `ttl`, `type`

Section

Column

width	40%

Return Formats:

Column

JSON, XML

Multiexcerpt include

MultiExcerptName	Short Macro
PageWithExcerpt	LIB:_XMLDeprecated

About WHM API 1

Include Page

	LIB:_WHMAPI1About
	LIB:_WHMAPI1About

Find a function

Livesearch

additional	page excerpt
placeholder	Search...
labels	whmapi1

Related functions

Content by Label

showLabels	false
max	5
showSpace	false
sort	modified
excerpt	true
excerptType	simple
operator	AND
cql	label = "dns" and label = "whmapi1"
labels	whmapi1,dns

Child pages

Versions Compared

Old Version 7

New Version 8

Key

Description

Examples

Parameters

Returns

Function information

About WHM API 1

Find a function

Related functions