Versions Compared

Old Version 7

changes.mady.by.user Bill Renner

Saved on

compared with

New Version 8

changes.mady.by.user Bill Renner

Saved on

Key

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

...

checkZone
URL/api/v1/api.php?target=zone&action=checkZone&zoneId=50
DescriptionRuns a zone file through Named checkzone
Returns

Examples:

SUCCESSFUL:{"success":1,"message":"No errors found."}
ERROR:{"success":0,"message":"21: ignoring out-of-zone data (veggie.com) 22: ignoring out-of-zone data (veggie.com) dns_rdata_fromtext: 23: near '2001:db8:': bad IPv6 address dns_rdata_fromtext: 24: near '1.2.3.': bad dotted quad dns_rdata_fromtext: 25: near '2001::db8::\/32': bad IPv6 address "}
Required Parameters
NameTypeExampleDescription
zoneIdINT50The Id of the zone to check.
getArchivedZone
URL/api/v1/api.php?target=zone&action=getArchivedZone
Description

Searches for all archived versions of the a zone. Zones are archived every time changes are pushed to their DNS Server.

Returns

Examples:

SUCCESSFUL:{"success":1,"message":"Search Successful.","data":[{"zoneArchiveId" :"2768","zoneId":"1227", "zoneArchiveTimestamp":"1375298692", "zoneArchiveFingerprint":"d060e59d69606326d80b2e55b50f0bc9","zoneName":"6connect.com","zoneIpver":null, "zoneMask":null,"zoneSerial": "2013073105","zoneRefresh":"14400","zoneRetry":"2000","zoneExpire":"604800", "zoneMinimum":"3600", "zoneSOA":null,"zoneTags":null,"zoneTTL":"3600","zoneEnableDNSSEC":"1", "zoneResourceId":"1013","zonePreviousViewLinkage":"[]"}]}
ERROR:{"success":0, "message":"error message"}


Data Detail:

NameTypeDescription
zoneIdINTThe Id of the Zone entry to find archived versions of.
zoneArchiveIdINTThe ID of the Archive Entry
zoneArchiveTimestampINTA timestamp marking when this zone was archived.
zoneArchiveFingerprintSTRINGA hash value identifying this zone. Used for comparing versions.
zoneNameINTZone Name.
zoneMaskINTZone Mask.
zoneSerialINTZone Serial.
zoneRefreshINTZone Refresh.
zoneRetryINTZone Retry.
zoneExpireINTZone Expire.
zoneMinimumINTZone Minimum.
zoneSOASTRINGZone SOA.
zoneTagsSTRINGZone Tags.
zoneTTLINTZone TTL.
zoneEnableDNSSECSTRINGWhether or not this version had DNSSEC enabled.
zoneResourceIdSTRINGZone Resource ID
zonePreviousViewLinkageJSONA JSON-encoded array of views this zone was linked to.
Optional Parameters
NameTypeExampleDescription
zoneIdINT123The Zone Id to search for.
zoneArchiveIdINT123The Zone Archive Id
zoneArchiveTimestampINT2012033001The Zone Archive Timestamp
fetchArchiveFileBOOL1Whether or not to return the full Zone file with the result set..

DNS Record Control

get
URL/api/v1/api.php?target=record&action=get
DescriptionAccepts search criteria to retrieve a list of all matching DNS Records. Search can be performed on any combination of Zone and Record attributes.
Returns

Examples:

SUCCESSFUL:{"success":1,"message":"Search Successful.","data":[{"recordId":"30894","recordZoneId":"229","recordHost":"@","recordType":"NS","recordValue":"ns1.domain.com.","recordDescription":"","recordTTL":""}]}
ERROR:{"success":0, "message":"error message"}


Data Detail:

NameTypeDescription
recordIdINTThe ID of this Record Entry. It is always included with its parent Zone.
recordZoneIdINTThe ID of this Record's parent Zone.
recordHostSTRINGThe Hostname of this Record.
recordTypeSTRINGThe Record Type (MX,NS,A,PTR,etc)
recordValueSTRINGThe Value of this Record.
recordDescriptionSTRINGA short description of this Record.
recordTTLSTRINGThe TTL of this Record.
Optional Parameters
NameTypeExampleDescription
likeFlagBOOL1When 1, string searches are done via LIKE with wildcards at both ends. When 0, strict comparison is used.
selectCountINT30When supplied only returns the first X entries
selectOffsetINT10When supplied, only returns entries after record X
sortArrayJSON{"zoneName":"desc","zoneMask":"asc"}A JSON-encoded object containing a list of columns to sort on and the direction in which to sort. Any API variable may be used for sorting. Valid sort directions are ASC and DESC.
NameTypeExampleDescription
recordIdINT123The Record ID to search for.
recordZoneIdINT123The parent Zone to search for.
recordHostSTRING@The Record Host to search for.
recordTypeSTRINGNSThe Record Type to search for.
recordValueSTRINGns1.dns.6connect.com.The Record Value to search for.
recordDescriptionSTRINGDescriptionSearch based on Record Description.
recordTTLSTRING3600The Record TTL to search for.

...