Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

add
URL/api/v1/api.php?target=dnsServer&action=add
DescriptionAdds a new DNS Server
Returns

Examples:

SUCCESSFUL:{"success":1,"message":"Add Successful."}
ERROR:{"success":0, "message":"error message"}
Required Parameters
NameTypeExampleDescription
serverSTRINGdns.yourdomain.comIP or FQDN of the DNS Server
usernameSTRINGbobuserLogin name for Server
passwordSTRINGpassword1Login password for Server
transferTypeSTRINGSCPProtocol used for transfer of DNS zones and records
serverTypeSTRINGMasterValues are 'Master' or 'Slave' only
displayNameSTRINGPrimary NSThe name displayed representing the DNS server, can be the same as server or different
Optional Parameters

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

NameTypeExampleDescription
customerNameSTRING/tmp/zonesCustomer Name
remoteDirectorySTRING/tmp/zonesZone Directory on Server
portINT22Port for ssh or scp access to server
namedConfPathSTRING/tmpPath where The path to the zone files used within the named.conf file resides on server.
preCommandSTRING/path/to/stuff/precommandCommand to execute before zone transfer
postCommandSTRING/path/to/stuff/postcommandCommand to execute after zone transfer
DNSSECContactSTRING For use with Dyn dns service
SOASTRINGns1.6connect.com. hostmaster.6connect.com.Server of Authority record for DNS server
activeINT0Values 0 or 1 only, sets the server to inactive on 0 value
powerDNSBackendSTRINGBind or MySQLpDNS server backend type
dbDatabaseNameSTRINGpdns_1DB name for pDNS servers with MySQL powerDNSBackend type
dbPortINT3306Port for for pDNS servers with MySQL powerDNSBackend type
dbUsernameSTRINGsomeuserDB username for pDNS servers with MySQL powerDNSBackend type
dbPasswordSTRINGsomepassDB password for pDNS servers with MySQL powerDNSBackend type

 

 

...