Page History

...

get

URL

/api/v1/api.php?target=zone&action=get

Description

Accepts search criteria to retrieve a list of all matching DNS Zones and associated Records.

Search can be performed on any combination of Zone and Record attributes.

Returns

Examples:

SUCCESSFUL:

{"success":1,"message":"Search Successful.","data":[{"zoneId":"64932","zoneName":"bind.com185.160.209.in-addr.arpa","zoneResourceId":"48381", "zoneSerial":"20121218052013040302","zoneRefresh":"028800","zoneRetry":"07200","zoneExpire":"0604800","zoneMinimum":"086400","zoneSOA":null, "zoneTags":null,"zoneTagszoneTTL":"Aaron, personal28800","zoneTTLzoneAutoCheck":"36001","zoneEnableDNSSEC":null,"recordId":"1154110","recordIdrecordZoneId":"16450932", "recordHost": "ns1185.160.209.inaddr.arpa.","recordType":"ANS","recordValue":"1auth01.2veroxity.3net.5","recordDescription":""null,"recordTTL":"28800", "recordOrdering":"41", "assetIdrecordErrors":"0"null,"unpagedRowsassetId":"116720","recordHostAssetuserCanCreate":0,"recordValueAssetuserCanDelete":1,"447userCanUpdate":1}]}

ERROR:

{"success":0, "message":"error message"}

Data Detail:

Name	Type	Description
zoneId	INT	The Id of the Zone entry. A single Zone entry might have multiple Records.
zoneName	STRING	The Zone name.
zoneResourceId	INT	The resource Id associated with this Zone.
zoneSerial	INT	Zone Serial.
zoneRefresh	INT	Zone Refresh.
zoneRetry	INT	Zone Retry.
zoneExpire	INT	Zone Expire.
zoneMinimum	INT	Zone Minimum.
zoneSOA	STRING	Zone SOA.
zoneTags	STRING	All the tags associated with this Zone.
zoneTTL	STRING	Zone TTL.
zoneEnableDNSSEC	BOOL	Whether or not DNSSEC is enabled for this Zone.
zoneAutoCheck	BOOL	Whether or not this zone is configured to be automatically validated on load/edit.
recordId	INT	The Id of this Record Entry. It is always included with its parent Zone.
recordHost	STRING	The Hostname of this Record.
recordType	STRING	The Record Type (MX,NS,A,PTR,etc)
recordValue	STRING	The Value of this Record.
recordDescription	STRING	A short description of this Record.
recordTTL	STRING	The TTL of this Record.
recordOrdering	INT	The numerical order in which the record appears in the zone.
recordErrors	STRING	A string containing any detected problems with this record
userCanCreate	BOOL	Whether or not the user has DNS CREATE permissions on this zone's resource
userCanUpdate	BOOL	Whether or not the user has DNS UPDATE permissions on this zone's resource
userCanDelete	BOOl	Whether or not the user has DNS DELETE permissions on this zone's resource
unpagedRows	INT	If pagination is used, this value will contain a total count of records had the pagination not been used.
assetId	INT	The numerical Id of the Asset best associated with this zone. Zero if such asset does not exist.
recordHostAsset	INT	The numerical Id of the Asset best associated with this recordHost. Zero if such asset does not exist.
recordValueAsset	INT	The numerical Id of the Asset best associated with this recordValue. Zero if such asset does not exist.

Optional Parameters

Name	Type	Example	Description
likeFlag	BOOL	1	When 1, string searches are done via LIKE with wildcards at both ends. When 0, strict comparison is used.
generalFlag	BOOL	1	When 1, searches over the provided parameters using OR. If 0 or omitted, uses AND.
selectCount	INT	30	When supplied only returns the first X entries
selectOffset	INT	10	When supplied, only returns entries after record X
sortArray	JSON	{"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.	searchForAssets	BOOL

0	When 1 or omitted, the search will return asset information. When 0, this information is not searched for.	Name	Type	Example	Description
zoneId	INT	123	The Zone Id to search for.
zoneName	STRING	foo	The Zone Name to search for.
zoneResourceId	INT	5	The Resource Id to search for.
zoneSerial	INT	2012033001	The Zone Serial to search for.
zoneRefresh	INT	36000	The Zone Refresh to search for.
zoneRetry	INT	800	The Zone Retry to search for.
zoneExpire	INT	6090000	The Zone Expire to search for.
zoneMinimum	INT	10	The Zone Minimum to search for.
zoneSOA	STRING	200	The Zone SOA to search for.
zoneTags	STRING	client,production	Zone Tags to search for.
zoneTTL	INT	3600	The Zone TTL to search for.
zoneEnableDNSSEC	INT	1	Search based on DNSSEC settings.
recordId	INT	123	The Record Id to search for.
recordZoneId	INT	123	The parent Zone to search for.
recordHost	STRING	@	The Record Host to search for.
recordType	STRING	NS	The Record Type to search for.
recordValue	STRING	ns1.dns.6connect.com.	The Record Value to search for.
recordDescription	STRING	Description	Search based on Record Description.
recordTTL	STRING	3600	The Record TTL to search for.

search

URL

/api/v1/api.php?target=zone&action=search

Description

Accepts search criteria to retrieve a list of all matching DNS Zones but NO associated Records. Search can be performed on any combination of Zone and Record attributes.

Returns

Examples:

SUCCESSFUL:

{"success":1,"message":"Search Successful.","data":[{"zoneId":"123","zoneName":"foobs.net","zoneResourceId":"483","zoneIpver":null,"zoneMask":null,"zoneSerial":"2012121803","zoneRefresh":null,"zoneRetry":null,"zoneExpire":null,"zoneMinimum":null,"zoneSOA":null,"zoneTags":"Aaron,Personal","zoneTTL":"3600","zoneEnableDNSSEC":"1","zoneLocalSigning":"1","assetId":"0","recordCount":"1","unpagedRows":"215"}]}

ERROR:

{"success":0, "message":"error message"}

Data Detail:

How many records are associated with this zone.

Name	Type	Description
zoneId	INT	The Id of the Zone entry. A single Zone entry might have multiple Records.
zoneName	STRING	The Zone name.
zoneResourceId	INT	The resource Id associated with this Zone.
zoneSerial	INT	Zone Serial.
zoneRefresh	INT	Zone Refresh.
zoneRetry	INT	Zone Retry.
zoneExpire	INT	Zone Expire.
zoneMinimum	INT	Zone Minimum.
zoneSOA	STRING	Zone SOA.
zoneTags	STRING	All the tags associated with this Zone.
zoneTTL	STRING	Zone TTL.
zoneEnableDNSSEC	BOOL	Whether or not DNSSEC is enabled for this Zone.
assetId	INT	The numerical Id of the Asset best associated with this zone. Zero if such asset does not exist.

zoneAutoCheck	BOOL	Whether or not this zone is configured to be automatically validated on load/edit.
recordCount	int	How many records are associated with this zone.
userCanCreate	BOOL	Whether or not the user has DNS CREATE permissions on this zone's resource
userCanUpdate	BOOL	Whether or not the user has DNS UPDATE permissions on this zone's resource
userCanDelete	BOOl	Whether or not the user has DNS DELETE permissions on this zone's resource	recordCount	int
unpagedRows	INT	If pagination is used, this value will contain a total count of records had the pagination not been used.

Optional Parameters

Name	Type	Example	Description
likeFlag	BOOL	1	When 1, string searches are done via LIKE with wildcards at both ends. When 0, strict comparison is used.
generalFlag	BOOL	1	When 1, searches over the provided paramenters using OR. If 0 or omitted, uses AND.
selectCount	INT	30	When supplied only returns the first X entries
selectOffset	INT	10	When supplied, only returns entries after record X
sortArray	JSON	{"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.	searchForAssets	BOOL

0	When 1 or omitted, the search will return asset information. When 0, this information is not searched for.	Name	Type	Example	Description
zoneId	INT	123	The Zone Id to search for.
zoneName	STRING	foo	The Zone Name to search for.
zoneResourceId	INT	5	The Resource Id to search for.
zoneSerial	INT	2012033001	The Zone Serial to search for.
zoneRefresh	INT	36000	The Zone Refresh to search for.
zoneRetry	INT	800	The Zone Retry to search for.
zoneExpire	INT	6090000	The Zone Expire to search for.
zoneMinimum	INT	10	The Zone Minimum to search for.
zoneSOA	STRING	200	The Zone SOA to search for.
zoneTags	STRING	client,production	Zone Tags to search for.
zoneTTL	INT	3600	The Zone TTL to search for.
zoneEnableDNSSEC	INT	1	Search based on DNSSEC settings.
recordId	INT	123	The Record Id to search for.
recordZoneId	INT	123	The parent Zone to search for.
recordHost	STRING	@	The Record Host to search for.
recordType	STRING	NS	The Record Type to search for.
recordValue	STRING	ns1.dns.6connect.com.	The Record Value to search for.
recordDescription	STRING	Description	Search based on Record Description.
recordTTL	STRING	3600	The Record TTL to search for.

...

add

URL

/api/v1/api.php?target=zone&action=add

Description

Adds a new DNS Zone.

Returns

Examples:

SUCCESSFUL:	{"success":1,"message":"Add Successful.","data":123}
ERROR:	{"success":0, "message":"error message"}

Data Detail:

Name	Type	Description
data	INT	The Id of the new Zone entry.

Required Parameters

Name	Type	Example	Description
zoneName	STRING	254.221.67.in-addr.arpa	The name for the new Zone.

Optional Parameters

Name	Type	Example	Description
zoneResourceId	STRING	123	Resource Id for the new Zone.
zoneSerial	INT	2012033001	Serial for the new Zone.
zoneRefresh	INT	36000	Refresh for the new Zone.
zoneRetry	INT	800	Retry for the new Zone.
zoneExpire	INT	6090000	Expire for the new Zone.
zoneMinimum	INT	10	Minimum for the new Zone.
zoneSOA	STRING	200	SOA for the new Zone.
zoneTags	STRING	client,production	Tags for the new Zone.
zoneTTL	STRING	3600	TTL for the new Zone.
zoneEnableDNSSEC	INT	1	Whether or not this new zone uses DNSSEC.
zoneAutoCheck	BOOL	1	Whether or not this zone is configured to be automatically validated on load/edit.

delete

URL

/api/v1/api.php?target=zone&action=delete

Description

Performs a search over the Zones and Records dataset and deletes all found Zones, plus all associated Records of those Zones.

Returns

Examples:

SUCCESSFUL:	{"success":1,"message":"Zones and Associated Records Deleted."}
ERROR:	{"success":0, "message":"error message"}

Optional Parameters

Name	Type	Example	Description
deleteZoneId	INT	123	The Zone Id to search for.
deleteZoneName	STRING	foo	The Zone Name to search for.
deleteZoneResourceId	INT	5	The Resource Id to search for.
deleteZoneSerial	INT	2012033001	The Zone Serial to search for.
deleteZoneRefresh	INT	36000	The Zone Refresh to search for.
deleteZoneRetry	INT	800	The Zone Retry to search for.
deleteZoneExpire	INT	6090000	The Zone Expire to search for.
deleteZoneMinimum	INT	10	The Zone Minimum to search for.
deleteZoneSOA	STRING	200	The Zone SOA to search for.
deleteZoneTags	STRING	client,production	Zone Tags to search for.
deleteZoneTTL	INT	3600	The Zone TTL to search for.
deleteZoneEnableDNSSEC	INT	1	Search based on DNSSEC settings.
deleteRecordId	INT	123	The Record Id to search for.
deleteRecordHost	STRING	@	The Record Host to search for.
deleteRecordType	STRING	NS	The Record Type to search for.
deleteRecordValue	STRING	ns1.dns.6connect.com.	The Record Value to search for.
deleteRecordDescription	STRING	Description	Search based on Record Description.
deleteRecordTTL	STRING	3600	The Record TTL to search for.

...

Page tree

Versions Compared

Old Version 6

New Version 7

Key