You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
Version 1
Next »
DNS Server Control
get |
---|
URL | /api/v1/api.php?target=dnsServer&action=get |
Description | If provided with an id, fetches that DNS Server from the database. If not, fetches a list of all stored DNS Servers |
Returns | Examples: SUCCESSFUL: | {"success":1,"message":"Fetch Sucessful.","data":[{"id":"3","server":"trace.6connect.com","username":"bremer", "password":"asdfasdfasdf","transferType":"SCP","remoteDirectory": "\/tmp\/zones2","namedConfPath":null,"active":"1"}, {"id":"4","server":"6connect.com","username":"bremer", "password":"1pw63bzij%7","transferType":"SCP","remoteDirectory": "\/tmp\/zones2","namedConfPath":"\/var\/named\/zones","active":"0"},{"id":"9","server":"dns.6connect.com", "username":"bremer", "password":"3435233","transferType":"SCP", "remoteDirectory": "\/zone","namedConfPath":null,"active":"0"}]} | 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 | CRYPT | 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? |
|
Optional Parameters | Name | Type | Example | Description |
---|
id | INTEGER | 15 | The server id to fetch. |
|
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 | 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 |
|
delete |
---|
URL | /api/v1/api.php?target=dnsServer&action=delete |
Description | Deletes a DNS Server |
Returns | Examples: SUCCESSFUL: | {"success":1,"message":"Delete Successful."} | ERROR: | {"success":0, "message":"error message"} |
|
Required Parameters | Name | Type | Example | Description |
---|
id | NUMERIC | 5 | ID of server to delete. |
|
Example URL | /api/v1/api.php?target=dnsServer&action=delete&id=5 |
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 | 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 |
|
getActive |
---|
URL | /api/v1/api.php?target=dnsServer&action=getActive |
Description | Returns the details of the active DNS Server |
Returns | Examples: SUCCESSFUL: | {"success":1,"message":"Active Server Fetched.","data":{"id":"3", "server":"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 |
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 | Examples: SUCCESSFUL: | {"success":1,"message":"Transfer Successful."} | ERROR: | {"success":0, "message":"error message"} |
|
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. |
Returns | Examples: SUCCESSFUL: | {"success":1,"message":"Updated Zone: $name.zone on $server via SCP"} | ERROR: | {"success":0, "message":"error message"} |
|
Required Parameters | Name | Type | Example | Description |
---|
companyID | NUMERIC | 5 | The CompanyID who owns the Zone | zoneID | NUMERIC | 35 | The ZoneID |
|
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. |
|
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:
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. | recordCount | int | How many records are associated with this zone. | 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. |
|
update |
---|
URL | /api/v1/api.php?target=zone&action=update |
Description | First performs a search based on the submitted Zone and Record criteria, then performs an Update across those entries based on new values. |
Returns | Examples: SUCCESSFUL: | {"success":1,"message":"Update Successful."} | ERROR: | {"success":0, "message":"error message"} |
|
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. |
Name | Type | Example | Description |
---|
searchZoneId | INT | 123 | The Zone Id to search for. | searchZoneName | STRING | foo | The Zone Name to search for. | searchZoneResourceId | INT | 5 | The Resource Id to search for. | searchZoneSerial | INT | 2012033001 | The Zone Serial to search for. | searchZoneRefresh | INT | 36000 | The Zone Refresh to search for. | searchZoneRetry | INT | 800 | The Zone Retry to search for. | searchZoneExpire | INT | 6090000 | The Zone Expire to search for. | searchZoneMinimum | INT | 10 | The Zone Minimum to search for. | searchZoneSOA | STRING | 200 | The Zone SOA to search for. | searchZoneTags | STRING | client,production | Zone Tags to search for. | searchZoneTTL | INT | 3600 | The Zone TTL to search for. | searchZoneEnableDNSSEC | INT | 1 | Search based on DNSSEC settings. | searchRecordId | INT | 123 | The Record Id to search for. | searchRecordHost | STRING | @ | The Record Host to search for. | searchRecordType | STRING | NS | The Record Type to search for. | searchRecordValue | STRING | ns1.dns.6connect.com. | The Record Value to search for. | searchRecordDescription | STRING | Description | Search based on Record Description. | searchRecordTTL | STRING | 3600 | The Record TTL to search for. |
Name | Type | Example | Description |
---|
updateZoneName | STRING | foo | The Zone name to replace into the searched rows. | updateZoneResourceId | INT | 5 | The Resource Id to replace into the searched rows. | updateZoneSerial | INT | 2012033001 | The Zone Serial to replace into the searched rows. | updateZoneRefresh | INT | 36000 | The Zone Refresh to replace into the searched rows. | updateZoneRetry | INT | 800 | The Zone Retry to replace into the searched rows.. | updateZoneExpire | INT | 6090000 | The Zone Expire to replace into the searched rows. | updateZoneMinimum | INT | 10 | The Zone Minimum to replace into the searched rows. | updateZoneSOA | STRING | 200 | The Zone SOA to replace into the searched rows. | updateZoneTags | STRING | client,production | Zone Tags to replace into the searched rows. | updateZoneTTL | INT | 3600 | The Zone TTL to replace into the searched rows. | updateZoneEnableDNSSEC | INT | 1 | Update DNSSEC Settings. | updateRecordHost | STRING | @ | The Record Host to replace into the searched rows. | updateRecordType | STRING | NS | The Record Type to replace into the searched rows. | updateRecordValue | STRING | ns1.dns.6connect.com. | The Record Value to replace into the searched rows. | updateRecordDescription | STRING | Description | Update Record Descriptions. | updateRecordTTL | STRING | 3600 | The Record TTL to replace into the searched rows. |
|
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. |
|
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. |
|
getRecordTypes |
---|
URL | /api/v1/api.php?target=zone&action=getRecordTypes |
Description | Returns a list of all Record Types allowed by the system. |
Returns | Examples: SUCCESSFUL: | {"success":1,"message":"Search Successful.","data":[{"recordType":"A"},{"recordType":"AAAA"},{"recordType":"MX"},{"recordType":"CNAME"},{"recordType":"PTRG"},{"recordType":"NS"},{"recordType":"TXT"},{"recordType":"DNSKEY"},{"recordType":"SRV"},{"recordType":"DS"},{"recordType":"TEST"}]} | ERROR: | {"success":0, "message":"error message"} |
Data Detail:
Name | Type | Description |
---|
recordType | STRING | A Record Type |
|
getFile |
---|
URL | /api/v1/api.php?target=zone&action=getFile&zoneId=50 |
Description | Returns a fully written zone file. If one does not exist, returns false. |
Returns | A Zone File |
Required Parameters | Name | Type | Example | Description |
---|
zoneId | INT | 50 | The Id of the zone to retrieve. |
|
getDSFile |
---|
URL | /api/v1/api.php?target=zone&action=getDSFile&zoneId=50 |
Description | Returns a fully written zone DS key file. If one does not exist, returns false. |
Returns | A Zone DS Key File |
Required Parameters | Name | Type | Example | Description |
---|
zoneId | INT | 50 | The Id of the zone whose DS keys wer are to retrieve. |
|
checkZone |
---|
URL | /api/v1/api.php?target=zone&action=checkZone&zoneId=50 |
Description | Runs 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 | Name | Type | Example | Description |
---|
zoneId | INT | 50 | The Id of the zone to check. |
|
DNS Record Control
get |
---|
URL | /api/v1/api.php?target=record&action=get |
Description | Accepts 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:
Name | Type | Description |
---|
recordId | INT | The ID of this Record Entry. It is always included with its parent Zone. | recordZoneId | INT | The ID of this Record's 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. |
|
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. | 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. |
Name | Type | Example | Description |
---|
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. |
|
update |
---|
URL | /api/v1/api.php?target=record&action=update |
Description | First performs a search based on the submitted Zone and Record criteria, then performs an Update across those entries based on new values. |
Returns | Examples: SUCCESSFUL: | {"success":1,"message":"Update Successful."} | ERROR: | {"success":0, "message":"error message"} |
|
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. |
Name | Type | Example | Description |
---|
searchZoneId | INT | 123 | The Zone ID to search for. | searchZoneName | STRING | foo | The Zone Name to search for. | searchZoneCustId | INT | 5 | The Customer ID to search for. | searchZoneIpver | STRING | IPv6 | The IP Version to search for. | searchZoneMask | STRING | | The Zone Mask to search for. | searchZoneSerial | INT | 2012033001 | The Zone Serial to search for. | searchZoneRefresh | INT | 36000 | The Zone Refresh to search for. | searchZoneRetry | INT | 800 | The Zone Retry to search for. | searchZoneExpire | INT | 6090000 | The Zone Expire to search for. | searchZoneMinimum | INT | 10 | The Zone Minimum to search for. | searchZoneSOA | STRING | 200 | The Zone SOA to search for. | searchZoneTags | STRING | client,production | Zone Tags to search for. | searchZoneTTL | INT | 3600 | The Zone TTL to search for. | searchZoneEnableDNSSEC | INT | 1 | Search based on DNSSEC settings. | searchRecordId | INT | 123 | The Record ID to search for. | searchRecordHost | STRING | @ | The Record Host to search for. | searchRecordType | STRING | NS | The Record Type to search for. | searchRecordValue | STRING | ns1.dns.6connect.com. | The Record Value to search for. | searchRecordDescription | STRING | Description | Search based on Record Description. | searchRecordTTL | STRING | 3600 | The Record TTL to search for. |
Name | Type | Example | Description |
---|
updateZoneName | STRING | foo | The Zone name to replace into the searched rows. | updateZoneCustId | INT | 5 | The Customer ID to replace into the searched rows. | updateZoneIpver | STRING | IPv6 | The IP Version to replace into the searched rows. | updateZoneMask | STRING | | The Zone Mask to replace into the searched rows. | updateZoneSerial | INT | 2012033001 | The Zone Serial to replace into the searched rows. | updateZoneRefresh | INT | 36000 | The Zone Refresh to replace into the searched rows. | updateZoneRetry | INT | 800 | The Zone Retry to replace into the searched rows.. | updateZoneExpire | INT | 6090000 | The Zone Expire to replace into the searched rows. | updateZoneMinimum | INT | 10 | The Zone Minimum to replace into the searched rows. | updateZoneSOA | STRING | 200 | The Zone SOA to replace into the searched rows. | updateZoneTags | STRING | client,production | Zone Tags to replace into the searched rows. | updateZoneTTL | INT | 3600 | The Zone TTL to replace into the searched rows. | updateZoneEnableDNSSEC | INT | 1 | Update DNSSEC Settings. | updateRecordHost | STRING | @ | The Record Host to replace into the searched rows. | updateRecordType | STRING | NS | The Record Type to replace into the searched rows. | updateRecordValue | STRING | ns1.dns.6connect.com. | The Record Value to replace into the searched rows. | updateRecordDescription | STRING | Description | Update Record Descriptions. | updateRecordTTL | STRING | 3600 | The Record TTL to replace into the searched rows. |
|
add |
---|
URL | /api/v1/api.php?target=record&action=add |
Description | Adds a new Record to a supplied 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 Record entry. |
|
Required Parameters | Name | Type | Example | Description |
---|
newRecordZoneId | INT | 123 | The Zone ID of the new Record. | newRecordHost | STRING | @ | New Host Name. | newRecordType | STRING | PTR | New Record Type. | newRecordValue | STRING | 123 | New Record Value. |
|
Optional Parameters | Name | Type | Example | Description |
---|
newRecordDescription | STRING | Description. | Notes for the Record. | newRecordTTL | INT | foo | Record TTL. |
|
delete |
---|
URL | /api/v1/api.php?target=record&action=delete |
Description | Performs a search over the Zones and Records dataset and deletes all found Records, but leaves their parent Zones intact. |
Returns | Examples: SUCCESSFUL: | {"success":1,"message":"Deletion Successful."} | 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. | deleteZoneCustId | INT | 5 | The Customer ID to search for. | deleteZoneIpver | STRING | IPv6 | The IP Version to search for. | deleteZoneMask | STRING | | The Zone Mask 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. |
|
switch |
---|
URL | /api/v1/api.php?target=record&action=switch |
Description | Switches the order of two record entries. |
Returns | Examples: SUCCESSFUL: | {"success":1,"message":"Record Moved."} | ERROR: | {"success":0, "message":"error message"} |
|
Required Parameters | Name | Type | Example | Description |
---|
moveWhichId | INT | 123 | The Record Id to be moved. | moveAfterId | INT | @ | The Id of the Record the first Record is to be moved after. |
|
Server-Zone Linkage
get |
---|
URL | /api/v1/api.php?target=zoneLinkage&action=get |
Description | Searches for Server-Zone Linkages. If no search parameters are supplied, all linkages are returned. |
Returns | Examples: SUCCESSFUL: | {"success":1,"message":"2 rows retrieved.","data":[{"id":"285","zoneId":"64","serverId":"1","serverName":"173.164.182.169","serverType":"SCP","serverMasterType":"master","zoneName":"bind.com","resourceId":"483"},{"id":"287","zoneId":"371","serverId":"1","serverName":"173.164.182.169","serverType":"SCP","serverMasterType":"master","zoneName":"132.235.198.in-addr.arpa","resourceId":"577"}} | ERROR: | {"success":0, "message":"error message"} |
Data Detail:
Name | Type | Description |
---|
id | INT | The Linkage Id. | zoneId | INT | The ZoneId involved in this link. | serverId | INT | The ServerId involved in this link. | serverName | STRING | The server name | serverType | STRING | The server transfer type | serverMasterType | STRING | Whether this server is a master or a slave. | zoneName | STRING | The zone name | resourceId | INT | The Resource Id the Zone is attached to. |
|
Optional Parameters | Name | Type | Example | Description |
---|
id | INTEGER | 15 | Fetches the linkage with the matching id. | serverId | INTEGER | 15 | Fetches all linkages with the matching serverId. | zoneId | INTEGER | 15 | Fetches all linkages with the matching zoneId. |
|
add |
---|
URL | /api/v1/api.php?target=zoneLinkage&action=add |
Description | Adds a new link between a DNS Server and a Zone |
Returns | Examples: SUCCESSFUL: | {"success":1,"message":"Link Added."} | ERROR: | {"success":0, "message":"error message"} |
|
Required Parameters | Name | Type | Example | Description |
---|
serverId | INT | 16 | The DNS Server Id. | zoneId | INT | 105 | The Zone Id. |
|
delete |
---|
URL | /api/v1/api.php?target=zoneLinkage&action=delete |
Description | Deletes a link between a DNS Server and a Zone |
Returns | Examples: SUCCESSFUL: | {"success":1,"message":"Link Deleted."} | ERROR: | {"success":0, "message":"error message"} |
|
Optional Parameters | Name | Type | Example | Description |
---|
id | INTEGER | 15 | Fetches the linkage with the matching id. | serverId | INTEGER | 15 | Fetches all linkages with the matching serverId. | zoneId | INTEGER | 15 | Fetches all linkages with the matching zoneId. |
|
Name Server Control
get |
---|
URL | /api/v1/api.php?target=nameServer&action=get |
Description | Fetches a list of all stored Name Servers |
Returns | Examples: SUCCESSFUL: | {"success":1,"message":"Fetch Sucessful.","data":[{"id":"1","nameserver":"ns1.dns.6connect.net","add_to_zones_default":"1","ordering":"10","uses":"34"},{"id":"10","nameserver":"ns2.dns.6connect.net","add_to_zones_default":"1","ordering":"11","uses":"46"},{"id":"9","nameserver":"ns4.dns.6connect.net","add_to_zones_default":"1","ordering":"14","uses":"12"},{"id":"3","nameserver":"ns3.dns.6connect.net","add_to_zones_default":"1","ordering":"15","uses":"46"}]} | ERROR: | {"success":0, "message":"error message"} |
Data Detail:
Name | Type | Description |
---|
id | INT | Server ID | nameserver | STRING | Server Name | add_to_zones_default | BOOL | Whether or not this is a default server. | ordering | INT | Display order | uses | INT | How many zones have been assigned to this NameServer |
|
add |
---|
URL | /api/v1/api.php?target=nameServer&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 |
---|
newServer | STRING | ns.yourdomain.com | Name of the NameServer |
|
delete |
---|
URL | /api/v1/api.php?target=nameServer&action=delete |
Description | Deletes a NameServer |
Returns | Examples: SUCCESSFUL: | {"success":1,"message":"Server Deleted."} | ERROR: | {"success":0, "message":"error message"} |
|
Required Parameters | Name | Type | Example | Description |
---|
id | NUMERIC | 5 | ID of server to delete. |
|
Example URL | /api/v1/api.php?target=nameServer&action=delete&id=5 |
setDefault |
---|
URL | /api/v1/api.php?target=nameServer&action=setDefault |
Description | Default NameServers have all new zones added to them as they are created. Multiple NameServers can be classified as Default. |
Returns | Examples: SUCCESSFUL: | {"success":1, "message":"Success."} | ERROR: | {"success":0, "message":"error message"} |
|
Required Parameters | Name | Type | Example | Description |
---|
id | NUMERIC | 5 | ID of server to modify. | value | 1 or 0 | 1 | 1 = Default, 0 = Normal |
|
Example URL | /api/v1/api.php?target=nameServer&action=setDefault&id=3&value=1 |
orderUp |
---|
URL | /api/v1/api.php?target=nameServer&action=orderUp |
Description | Swaps the index order of the targeted NameServer with that of the one above it. |
Returns | Examples: SUCCESSFUL: | {"success":1,"message":"Reordering Successful."} | ERROR: | {"success":0, "message":"error message"} |
|
Example URL | /api/v1/api.php?target=nameServer&action=orderUp&id=3 |
orderDown |
---|
URL | /api/v1/api.php?target=nameServer&action=orderDown |
Description | Swaps the index order of the targetted NameServer with that of the one below it. |
Returns | Examples: SUCCESSFUL: | {"success":1,"message":"Reordering Successful."} | 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=nameServer&action=orderDown&id=5 |