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:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
| ||||||||
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.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Example URL | /api.php?target=dnsServer&action=update&id=74&transferType=SCP&server=dns.yourdomain.com&SOA=ns1.6connect.com.+hostmaster.6connect.com. |
transferByServer | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=dnsServer&action=transferByServer | ||||||||
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 |
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 |
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:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters |
|
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:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters |
|
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 | Examples:
| ||||||||||||||||||||||||||||||||||||||||||||||||
Required Parameters |
| ||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters |
|
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:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters |
|
getRecordTypes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=zone&action=getRecordTypes | ||||||||||
Description | Returns a list of all Record Types allowed by the system. | ||||||||||
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 |
|
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 |
|
checkZone | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=zone&action=checkZone&zoneId=50 | ||||||||
Description | Runs a zone file through Named checkzone | ||||||||
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 | Examples:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters |
|
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:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters |
|
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:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters |
|
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 |
|
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:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Optional Parameters |
|
switch | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=record&action=switch | ||||||||||||
Description | Switches the order of two record entries. | ||||||||||||
Returns | Examples:
| ||||||||||||
Required Parameters |
|
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:
| |||||||||||||||||||||||||||||||
Optional Parameters |
|
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 |
|
delete | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=zoneLinkage&action=delete | ||||||||||||||||
Description | Deletes a link between a DNS Server and a Zone | ||||||||||||||||
Returns | Examples:
| ||||||||||||||||
Optional Parameters |
|
Name Server Control
get | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=nameServer&action=get | ||||||||||||||||||||||
Description | Fetches a list of all stored Name Servers | ||||||||||||||||||||||
Returns | Examples:
|
add | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=nameServer&action=add | ||||||||
Description | Adds a new DNS Server | ||||||||
Returns | Examples:
| ||||||||
Required Parameters |
|
delete | |||||||||
---|---|---|---|---|---|---|---|---|---|
URL | /api/v1/api.php?target=nameServer&action=delete | ||||||||
Description | Deletes a NameServer | ||||||||
Returns | Examples:
| ||||||||
Required Parameters |
| ||||||||
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 |
| ||||||||||||
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:
| ||||
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 |
| ||||||||
Example URL | /api/v1/api.php?target=nameServer&action=orderDown&id=5 |