Table of Contents |
---|
DNS Server Control
Warning |
---|
ProVision's APIv1 system has been replaced by APIv2, and is now considered deprecated. |
Table of Contents |
---|
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:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Required Parameters | None | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=dnsServer&action=get&id=15 |
add | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=dnsServer&action=add | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description | Adds a new DNS Server | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Returns | Examples:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Required Parameters |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters | These optional parameters vary according to what type of server is being configured.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=dnsServer&action=add&server=dns.yourdomain.com&transferType=Secure64&displayName=PrimaryNS&serverType=master&password=password1&SOA=ns1.6connect.com.+hostmaster.6connect.com. |
delete | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=dnsServer&action=delete | ||||||||
Description | Deletes a DNS Server | ||||||||
Returns | Examples:
| ||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
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:
| |||||||||||||||||||||||||||||
Required Parameters |
| |||||||||||||||||||||||||||||
Optional Parameters | These optional parameters vary according to what type of server is being configured.
|
transferAll | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=dnsServer&action=transferServer | ||||||||
Description | Performs a full zone push on a DNS Server, executing pre and post commands, transferring files, and restarting services. | ||||||||
Returns | Examples:
| ||||||||
Required Parameters |
|
transferSingle | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=dnsServer&action=transferSingle | ||||||||
Description | Transfers a single Zone file 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:
| ||||||||
Required Parameters |
|
DNS Zone Control
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example URL | /api.php?target=dnsServer&action=update&id=74&transferType=SCP&server=dns.yourdomain.com&SOA=ns1.6connect.com.+hostmaster.6connect.com. |
transferServer | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=dnsServer&action=transferServer | ||||||||
Description | Performs a full zone push on a DNS Server, executing pre and post commands, transferring files, and restarting services. | ||||||||
Returns | Examples:
| ||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
Example URL | /api/v1/api.php?target=dnsServer&action=transferServer&push=1 |
transferSingle | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=dnsServer&action=transferSingle | ||||||||
Description | Transfers a single Zone file 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:
| ||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
Example URL | /api/v1/api.php?target=dnsServer&action=transferSingle&zoneId=35 |
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:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Required Parameters | None | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=zone&action=get&zoneId=123 |
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:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Required Parameters | None | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=zone&action=search&zoneId=123 |
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:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Required Parameters | None | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
SUCCESSFUL: | {"success":1,"message":"Search Successful.","data":[{"zoneId":"932","zoneName":"185.160.209.in-addr.arpa","zoneResourceId":"81", "zoneSerial":"2013040302","zoneRefresh":"28800","zoneRetry":"7200","zoneExpire":"604800","zoneMinimum":"86400","zoneSOA":null, "zoneTags":null,"zoneTTL":"28800","zoneAutoCheck":"1","zoneEnableDNSSEC":null,"recordId":"154110","recordZoneId":"932", "recordHost": "185.160.209.inaddr.arpa.","recordType":"NS","recordValue":"auth01.veroxity.net.","recordDescription":null,"recordTTL":"28800", "recordOrdering":"1", "recordErrors":null,"assetId":"0","userCanCreate":0,"userCanDelete":1,"userCanUpdate":1}]} |
ERROR: | {"success":0, "message":"error message"} |
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. |
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. |
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
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"} |
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 | ||||
generalFlag | BOOL | 1 | When 1, searches over the provided parameters using OR. If 0 or omitted, uses AND | 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 | ||
---|---|---|---|---|---|
zoneIdsearchZoneId | INTINTEGER | 123 | The Zone Id to search for. | ||
zoneNamesearchZoneName | STRING | foo | The Zone Name to search for. | ||
zoneResourceIdsearchZoneResourceId | INTINTEGER | 5 | The Resource Id to search for. | ||
zoneSerialsearchZoneSerial | INTINTEGER | 2012033001 | The Zone Serial to search for. | ||
zoneRefreshsearchZoneRefresh | INTINTEGER | 36000 | The Zone Refresh to search for. | ||
zoneRetrysearchZoneRetry | INTINTEGER | 800 | The Zone Retry to search for. | ||
zoneExpiresearchZoneExpire | INTINTEGER | 6090000 | The Zone Expire to search for. | ||
zoneMinimumsearchZoneMinimum | INTINTEGER | 10 | The Zone Minimum to search for. | ||
zoneSOAsearchZoneSOA | STRING | 200 | The Zone SOA to search for. | ||
zoneTags | STRING | client,production | Zone Tags to search for. | ||
searchZoneTTL | INTEGER | zoneTTL | INT | 3600 | The Zone TTL to search for. |
zoneEnableDNSSECsearchZoneEnableDNSSEC | INTINTEGER | 1 | Search based on DNSSEC settings. | ||
recordIdsearchRecordId | INTINTEGER | 123 | The Record Id to search for. | ||
recordZoneId | INT | 123 | The parent Zone to search for. | ||
recordHostsearchRecordHost | STRING | @ | The Record Host to search for. | ||
recordTypesearchRecordType | STRING | NS | The Record Type to search for. | ||
recordValuesearchRecordValue | 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
searchRecordDescription | STRING |
Description |
Search based on |
Examples:
SUCCESSFUL: | {"success":1,"message":"Update Successful."} |
ERROR: | {"success":0, "message":"error message"} |
Record Description. | |||
searchRecordTTL | STRING | 3600 | The Record TTL to search for. |
Name | Type | Example | Description |
---|---|---|---|
likeFlagupdateZoneName | BOOLSTRING | 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.
foo | The Zone name to replace into the searched rows. | ||
updateZoneSerial | INTEGER | 2012033001 | The Zone Serial to replace into the searched rows. |
updateZoneRefresh | INTEGER | 36000 | The Zone Refresh to replace into the searched rows. |
updateZoneRetry | INTEGER | 800 | The Zone Retry to replace into the searched rows.. |
updateZoneExpire | INTEGER | 6090000 | The Zone Expire to replace into the searched rows. |
updateZoneMinimum | INTEGER | 10 | The Zone Minimum to replace into the searched rows. |
updateZoneSOA | STRING | 200 | The Zone SOA to replace into the searched rows. |
updateZoneTTL | INTEGER | 3600 | The Zone TTL to replace into the searched rows. |
updateZoneEnableDNSSEC | INTEGER | 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. |
updateZoneAutoCheck | BOOL | 1 | Whether or not this zone is configured to be automatically validated on load/edit. |
Name | Type | Example | Description |
---|---|---|---|
recordZoneId | INTEGER | 123 | The parent zone ID |
add | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=zone&action=add | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description | Adds a new DNS Zone. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Returns | Examples:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Required Parameters |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=zone&action=add&zoneName=254.221.67.in-addr.arpa&zoneSerial=2012033001 |
deleteadd | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=zone&action=adddelete | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DescriptionAdds | a new DNS ZonePerforms a search over the Zones and Records dataset and deletes all found Zones, plus all associated Records of those Zones. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Required Parameters | No specific parameter is required, however, one or more optional parameters must be used for a successful return | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=zone&action=delete&deleteZoneId=123 |
getRecordTypesdelete | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getRecordTypes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description | Returns a list of all Record Types allowed by the system. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Returns | Examples:
| Returns | Examples:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Required Parameters | None | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters | None | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=zone&action=getRecordTypes |
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 |
| ||||||||||||||||
Optional Parameters | None | ||||||||||||||||
Example URL | /api/v1/api.php?target=zone&action=getFile&zoneId=50&zoneId=50&format=html&unsigned=1 |
getDSFile | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=zone&action=getDSFile | ||||||||
Description | Returns a fully written zone DS key file. If one does not exist, returns false. | ||||||||
Returns | A Zone DS Key File | ||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
Example URL | /api/v1/api.php?target=zone&action=getDSFile&zoneId=50 |
checkZonegetRecordTypes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=zone&action=getRecordTypescheckZone | ||||||||||
DescriptionReturns a list of all Record Types allowed by the system. | Runs a zone file through Named checkzone | ||||||||||
Returns | Examples:
| ||||||||||
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 |
| ||||||||||
Optional Parameters | getDSFileNone | ||||||||||
Example 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 | ||||||||||
checkZone&zoneId=50 |
getArchivedZone | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Required Parameters |
| ||||||||||||||||||||
checkZone | |||||||||||||||||||||
URL | /api/v1/api.php?target=zone&action=checkZone&zoneId=50getArchivedZone | ||||||||||||||||||||
DescriptionRuns | a zone file through Named checkzone Searches for all archived versions of the a zone. Zones are archived every time changes are pushed to their DNS Server. | ||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||
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 |
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"} |
Name | Type | Description |
---|---|---|
zoneId | INT | The Id of the Zone entry to find archived versions of. |
zoneArchiveId | INT | The ID of the Archive Entry |
zoneArchiveTimestamp | INT | A timestamp marking when this zone was archived. |
zoneArchiveFingerprint | STRING | A hash value identifying this zone. Used for comparing versions. |
zoneName | INT | Zone Name. |
zoneMask | INT | Zone Mask. |
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 | Zone Tags. |
zoneTTL | INT | Zone TTL. |
zoneEnableDNSSEC | STRING | Whether or not this version had DNSSEC enabled. |
zoneResourceId | STRING | Zone Resource ID |
zonePreviousViewLinkage | JSON | A JSON-encoded array of views this zone was linked to. |
Name | Type | Example | Description |
---|---|---|---|
zoneId | INT | 123 | The Zone Id to search for. |
zoneArchiveId | INT | 123 | The Zone Archive Id |
zoneArchiveTimestamp | INT | 2012033001 | The Zone Archive Timestamp |
fetchArchiveFile | BOOL | 1 | Whether or not to return the full Zone file with the result set.. |
DNS Record Control
| |||||||||||||||||||||||||||||||||||||||||||||||||||
Required Parameters | None | ||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters |
| ||||||||||||||||||||||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=zone&action=getArchivedZone&zoneId=123 |
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:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Required Parameters | None | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=record&action=get&selectCount=30&zoneId=123 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
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"} |
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. |
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. |
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:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Required Parameters | None | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=record&action=update&searchZoneId=123&updateZoneTTL=3600 |
add | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=record&action=add | ||||||||||||||||||||||||
Description | Adds a new Record to a supplied Zone. | ||||||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||||||
Optional Parameters |
| ||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=record&action=add&newRecordZoneId=123&newRecordHost=@host&newRecordType=PTR&newRecordTTL=3600 |
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:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Required Parameters | None | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=record&action=delete&deleteZoneName=foo |
switch | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=record&action=switch | ||||||||||||
Description | Switches the order of two record entries. | ||||||||||||
Returns | Examples:
| ||||||||||||
Required Parameters |
| ||||||||||||
Optional Parameters | None | ||||||||||||
Example URL | /api/v1/api.php?target=record&action=switch&moveWhichId=123&moveAfterId=42 |
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:
| |||||||||||||||||||||||||||||||
Required Parameters | None | |||||||||||||||||||||||||||||||
Optional Parameters |
| |||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=zoneLinkage&action=get&id=15 |
add | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=zoneLinkage&action=add | ||||||||||||||||||||||||
Description | Adds a new link between a DNS Server and a Zone | ||||||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||||||
Optional Parameters | None | ||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=zoneLinkage&action=add&serverId=16&zoneId=105&serverSlave=0 |
delete | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=zoneLinkage&action=delete | ||||||||||||||||
Description | Deletes a link between a DNS Server and a Zone | ||||||||||||||||
Returns | Examples:
| ||||||||||||||||
Required Parameters | None | ||||||||||||||||
Optional Parameters |
| ||||||||||||||||
Example URL | /api/v1/api.php?target=zoneLinkage&action=delete |
Name Server Control
get | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=nameServer&action=get | |||||||||||||||||||||||
Description | Fetches a list of all stored Name Servers | |||||||||||||||||||||||
Returns | Examples:
| |||||||||||||||||||||||
Required Parameters | None | |||||||||||||||||||||||
Optional Parameters |
| |||||||||||||||||||||||
Example URL | /api/v1/api.php?target=nameServer&action=get&default=1 |
add | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=nameServer&action=add | ||||||||
Description | Adds a new DNS Server | ||||||||
Returns | Examples:
| ||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
Example URL | /api/v1/api.php?target=nameServer&action=add&newServer=ns.yourdomain.com |
delete | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=nameServer&action=delete | ||||||||
Description | Deletes a NameServer | ||||||||
Returns | Examples:
| ||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
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:
| ||||||||||||
Required Parameters |
| ||||||||||||
Optional Parameters | None | ||||||||||||
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:
| ||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
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 targeted NameServer with that of the one below it. | ||||||||
Returns | Examples:
| ||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
Example URL | /api/v1/api.php?target=nameServer&action=orderDown&id=5 |
...