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
passwordSTRINGpassword1Login password for Server
transferTypeSTRINGSCPProtocol used for transfer of DNS zones and records. Valid settings include SCP, PowerDNS, Secure64, Secure64Signer
serverTypeSTRINGMasterValues are 'Master' or 'Slave' only
displayNameSTRINGPrimary NSThe name displayed representing the DNS server, can be the same as server or different
SOASTRINGns1.6connect.com. hostmaster.6connect.com.Server of Authority record for DNS server
Optional Parameters

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

NameTypeExampleDescription
customerNameSTRING/tmp/zonesCustomer Name
remoteDirectorySTRING/tmp/zonesZone Directory on Server
portINTEGER22Port for ssh or scp access to server
namedConfPathSTRING/tmpThe path to the zone files used within the named.conf file.
preCommandSTRING/path/to/stuff/precommandCommand to execute before zone transfer
postCommandSTRING/path/to/stuff/postcommandCommand to execute after zone transfer
DNSSECContactSTRINGjoeuserFor use with Dyn dns service
usernameSTRINGbobuserLogin name for Server
activeINTEGER0Values 0 or 1 only, sets the server to inactive on 0 value
masteridmasterIdINTEGER53Master server ID. If a server is a slave, masterid masterId points to its master.
powerDNSBackendSTRINGBind or MySQLpDNS server backend type
dbDatabaseNameSTRINGpdns_1DB name for pDNS servers with MySQL powerDNSBackend type
dbPortINTEGER3306Port 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
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.

 

...