Child pages
  • WHM API 1 Functions - resetzone

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function resets a DNS zone to its default values.

 This also resets the domain's subdomain DNS records, and restores zone file subdomains in the server's httpd.conf file. For example, use this function to restore DNS zones that are corrupt.

Note
titleNote:

Zone resets preserve valid TXT records, but all other records will return to their default values. 

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledDNSRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/resetzone?api.version=1&domain=example.com



Expand
titleXML API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/resetzone?api.version=1&domain=example.com



Expand
titleCommand Line


Code Block
languagebash
whmapi1 resetzone domain=example.com 

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "resetzone"
  }
}



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>resetzone</command>
    </metadata>
</result>


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


Parameters  

Note
titleNote:

You must include either the domain or the zone parameters. 


ParameterTypeDescriptionPossible valuesExample

domain

string

The domain.

A valid domain on the server.example.com
zonestring

The zone file.

A valid zone file name.zonefile
userstringThe domain's owner.A valid username on the server.user

Returns

This function only returns metadata.