...

add

URL

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

Description

Adds a new DNS Server

Returns

Examples:

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

Required Parameters

Name	Type	Example	Description
server	STRING	dns.yourdomain.com	Address of the DNS Server
username	STRING	bobuser	Login name for Server
password	STRING	password1	Login password for Server
transferType	STRING	SCP	Protocol

Optional Parameters

There optional parameters vary according to what type of server is being configured.

Name	Type	Example	Description
customerName	STRING	/tmp/zones	Customer Name
remoteDirectory	STRING	/tmp/zones	Zone Directory on Server
namedConfPath	STRING	/tmp	Zone Path
preCommand	STRING	/path/to/stuff/precommand
postCommand	STRING	/path/to/stuff/postcommand

...

update

URL

/api/v1/api.php?target=dnsServer&action=update

Description

Updates an existing DNS Server with new information.

Returns

Examples:

SUCCESSFUL:	{"success":1,"message":"Update Successful."}
ERROR:	{"success":0, "message":"error message"}

Required Parameters

Name	Type	Example	Description
username	STRING	bobuser	Login name for Server
password	STRING	password1	Login password for Server
transferType	STRING	SCP	Protocol

Optional Parameters

There optional parameters vary according to what type of server is being configured.

Name	Type	Example	Description
customerName	STRING	/tmp/zones	Customer Name
remoteDirectory	STRING	/tmp/zones	Zone Directory on Server
namedConfPath	STRING	/tmp	Zone Path
preCommand	STRING	/path/to/stuff/precommand
postCommand	STRING	/path/to/stuff/postcommand

getActivetransferAll

URL

/api/v1/api.php?target=dnsServer&action=getActivetransferServer

DescriptionReturns

the details of the active DNS ServerPerforms a full zone push on a DNS Server, executing pre and post commands, transferring files, and restarting services.

Returns

Examples:

SUCCESSFUL:	{"success":1,"message":"Active Server FetchedTransfer Successful.","data":}
ERROR:	{"idsuccess":"3"0, "servermessage":"trace.6connect.com","username":"bremer","password":"asdfd3fs", "transferType":"SCP","remoteDirectory":"\/tmp\/zones2","namedConfPath":null,"active":"1"}}
ERROR:	{"success":0, "message":"error message"}

Data Detail:

Name	Type	Description
id	INT	Server ID
server	STRING	Server Name
username	STRING	Login Name
password	CRYPT	Login Password
customerName	STRING	Customer Name
transferType	STRING	Type of Transfer
remoteDirectory	STRING	The remote path this server is configured for
namedConfPath	STRING	Internal configuration path
preCommand	STRING	The command to be run on the DNS server before the zone push.
postCommand	STRING	The command to be run on the DNS server after the zone push.
active	BOOL	Is this the currently active DNS server?

setActive

URL

/api/v1/api.php?target=dnsServer&action=setActive

Description

Designates a DNS server as Active. De-activates any existing Active servers.

Returns

Examples:

SUCCESSFUL:	{"success":1,"message":"Active Server Updated."}
ERROR:	{"success":0, "message":"error message"}

Required Parameters

Name	Type	Example	Description
id	NUMERIC	5	ID of server to activate.

Example URL

/api/v1/api.php?target=dnsServer&action=setActive&id=5

Examples:

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

error message"}

Required Parameters

Name	Type	Example	Description
push	INT	1	The ID of the server to push zones to

transferAll

URL

/api/v1/api.php?target=dnsServer&action=setActive

Description

Transfer all written Zone files from the 6Connect instance to the Active DNS Server.

Returns

SUCCESSFUL:

{"success":1,"message":"Transfer Successful."}

ERROR:

transferSingle

URL

/api/v1/api.php?target=dnsServer&action=transferSingle

Description

Transfers a single Zone file

from the 6Connect instance to the Active DNS Server

to all its associated DNS Servers, along with updated server configurations.

Performs pre and post commands on the target servers, transfers the zone file(s), and restarts services.

Returns

Examples:

SUCCESSFUL:	{"success":1,"message":"Updated Zone: $name.zone on $server via SCP"}
ERROR:	{"success":0, "message":"error message"}

Required Parameters

The CompanyID who owns the Zone

Name	Type	Example	Description	companyID	NUMERIC	5
zoneID	NUMERIC	35	The ZoneIDID of the zone to push

DNS Zone Control

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":"64","zoneName":"bind.com","zoneResourceId":"483","zoneSerial":"2012121805","zoneRefresh":"0","zoneRetry":"0","zoneExpire":"0","zoneMinimum":"0","zoneSOA":"","zoneTags":"Aaron, personal","zoneTTL":"3600","zoneEnableDNSSEC":"1","recordId":"16450","recordHost":"ns1","recordType":"A","recordValue":"1.2.3.5","recordDescription":"","recordTTL":"","recordOrdering":"4","assetId":"0","unpagedRows":"11672","recordHostAsset":0,"recordValueAsset":"447"}]}

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

...

Page tree

Versions Compared

Old Version 5

New Version 6

Key

DNS Zone Control

Page tree

Page History

Versions Compared

Old Version 5

New Version 6

Key

DNS Zone Control