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:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
add | |||||||||||||||||||||||||||||||||||||||||||||||||||||
URL | /api/v1/api.php?target=dnsServer&action=add | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Description | Adds a new DNS Server | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
Required Parameters | None | 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 |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=dnsServer&action=get&id=15 |
add | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | / | |||||||||||||||||||||||||||||||||||||
delete | ||||||||||||||||||||||||||||||||||||||
URL | /api/v1/api.php?target=dnsServer&action=deleteadd | |||||||||||||||||||||||||||||||||||||
Description | Deletes Adds a new DNS Server | |||||||||||||||||||||||||||||||||||||
Returns | Examples:
| |||||||||||||||||||||||||||||||||||||
Required Parameters |
| |||||||||||||||||||||||||||||||||||||
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. Optional Parameters
| |||||||||||||||||||||||||||||||||||||
getActive | ||||||||||||||||||||||||||||||||||||||
URL | /api/v1/api.php?target=dnsServer&action=getActive | |||||||||||||||||||||||||||||||||||||
Description | Returns the details of the active DNS Server | Returns |
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"} |
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? |
Command to execute after zone transfer | |||
DNSSECContact | STRING | joeuser | For use with Dyn dns service |
username | STRING | bobuser | Login name for Server |
active | INTEGER | 0 | Values 0 or 1 only, sets the server to inactive on 0 value |
masterId | INTEGER | 53 | Master server ID. If a server is a slave, masterId points to its master. |
powerDNSBackend | STRING | Bind or MySQL | pDNS server backend type |
dbDatabaseName | STRING | pdns_1 | DB name for pDNS servers with MySQL powerDNSBackend type |
dbPort | INTEGER | 3306 | Port for for pDNS servers with MySQL powerDNSBackend type |
dbUsername | STRING | someuser | DB username for pDNS servers with MySQL powerDNSBackend type |
dbPassword | STRING | somepass | DB password for pDNS servers with MySQL powerDNSBackend type |
/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 | Description | Designates a DNS server as Active. De-activates any existing Active servers. | ||||||
Returns | Examples:
| ||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
Example URL | /api/v1/api.php?target=dnsServer&action=setActivedelete&id=5 |
transferAllupdate | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=dnsServer&action=setActiveupdate | ||||||||||||||||||||
Description | Transfer all written Zone files from the 6Connect instance to the Active DNS ServerUpdates an existing DNS Server with new information. | ||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||
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:
| ||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||
Optional Parameters | Required Parameters | These optional parameters vary according to what type of server is being configured. |
|
DNS Zone Control
...
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"} |
...
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. |
...
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. |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=zone&action=update&searchZoneId=123&updateZoneExpire=6090000 |
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 |
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:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
getRecordTypes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=zone&action=getRecordTypes | ||||||||||
Description | Returns a list of all Record Types allowed by the system. | ||||||||||
Returns | Examples:
| ||||||||||
Required Parameters | None | ||||||||||
Optional Parameters | None | ||||||||||
Example URL | /api/v1/api.php?target=zone&action=getRecordTypes |
getFile |
---|
...
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 | 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. |
...
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:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters |
|
add | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=zone&action=add | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description | Adds a new DNS Zone. | Returns |
SUCCESSFUL: | {"success":1,"message":"Add Successful.","data":123} |
ERROR: | {"success":0, "message":"error message"} |
Name | Type | Description |
---|---|---|
data | INT | The Id of the new Zone entry. |
Name | Type | Example | Description |
---|---|---|---|
zoneName | STRING | 254.221.67.in-addr.arpa | The name for the new Zone. |
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. |
Examples:
SUCCESSFUL: | {"success":1,"message":"Zones and Associated Records Deleted."} |
ERROR: | {"success":0, "message":"error message"} |
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. |
Name | Type | Example | Description |
---|---|---|---|
zoneId | INTEGER | 50 | The Id of the zone to retrieve. |
format | ENUMERATED | 'html' or " | If html, the zone file will be formatted for display via a web browser. If blank or omitted, the zone file will be formatted for display in a file system. |
unsigned | BOOL | 1 | For a DNSSEC-enabled zone, determines whether or not the system retrieves the signed or unsigned zone file. Ignored for non-DNSSEC zones. |
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 |
checkZone | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=zone&action=checkZone | ||||||||
Description | Runs a zone file through Named checkzone | ||||||||
Returns | Examples:
| ||||||||
Required Parameters |
| ||||||||
Optional Parameters | None | ||||||||
Example URL | /api/v1/api.php?target=zone&action=checkZone&zoneId=50 |
getArchivedZone | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
getRecordTypes | |||||||||||
URL | /api/v1/api.php?target=zone&action=getRecordTypesgetArchivedZone | ||||||||||
DescriptionReturns | a list of all Record Types allowed by the system Searches for all archived versions of the a zone. Zones are archived every time changes are pushed to their DNS Server. | ||||||||||
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 | ||||||||||
|
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 |
|
| |||||||||||||||||||||||||||||||||||||||||||
Required Parameters | None | ||||||||||||||||||||||||||||||||||||||||||
Optional Parameters | |||||||||||||||||||||||||||||||||||||||||||
checkZone | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=zone&action=checkZone&zoneId=50 | ||||||||||||||||||||||||||||||||||||||||||
Description | Runs a zone file through Named checkzone | ||||||||||||||||||||||||||||||||||||||||||
Returns | Examples:
| ||||||||||||||||||||||||||||||||||||||||||
Required 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.Record attributes. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Returns | Examples:
| Returns | Examples:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Required Parameters | None | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters | Optional Parameters |
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example URL | /api/v1/api.php?target=record&action=get&selectCount=30&zoneId=123 |
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 targetted 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 |
...