Table of Contents

DNS Server Control

Warning
ProVision's APIv1 system has been replaced by APIv2, and is now considered deprecated.

Table of Contents

add

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:

SUCCESSFUL:

{"success":1,"message":"Fetch Sucessful.","data":[{"id":"

3

10","server":"

trace.6connect.com

mrbomasm-dns-4.onnet.net", "username":"

bremer

user", "password":"

asdfasdfasdf

vwvddp","

transferType

port":"

SCP

2600","

remoteDirectory": "\/tmp\/zones2","namedConfPath"

customer_name":null,"

active

transfer_type": "

1

SCP"

}

,

{

"

id

remote_directory":"

4

zones", "

server

named_conf_path":"

6connect.com

\/etc\/zones","

username

active":"

bremer

1","

password

post_command":null,"

1pw63bzij%7

pre_command":null,"

transferType

dyn_DNSSEC_contact":

"SCP"

null, "

remoteDirectory

powerdns_backend":"

\/tmp\/zones2

Bind","

namedConfPath

db_username":

"\/var\/named\/zones"

null,"

active

db_password":"

0

("

}

,

{

"

id

db_port":null,"

9

db_name":null, "server_type":"

dns.6connect.com

slave","

username

SOA":

"bremer"

null,"

password

master_id":

"3435233"

null,"

transferType

options": "

SCP", "remoteDirectory

{\"customer_name\":\"\

/zone

",\"

namedConfPath

server_type\":

null

\"slave\" ,\"

active

SOA\":

"0"}]}

ERROR:

{"success":0, "message":"error message"}

Data Detail:

Name	Type	Description
id	INT	Server ID
server	STRING	Server Name
username	STRING	Login Name
password	CRYPT	Login Password
customerName	CRYPT	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?

Optional Parameters

\"\",\"remote_directory\":\"zones\", \"named_conf_path\":\"\\\/etc\\\/zones\", \"dyn_DNSSEC_contact\" :\"\",\"post_command\":\"\" ,\"pre_command\":\"\",\"powerdns_backend\":\"Bind\", \"db_username\":\"\",\"db_password\":\"(\",\"db_port\":\"\",\"db_name\":\"\",\"enable_views\":\"1\"}", "testID":"963","zoneCount":"8","views":"[{\"id\":\"1\", \"server_id\":\"10\",\"name\":\"_6connectDefault\",\"extras\":\"[]\",\"description\":\"\",\"timestamp\":\"1371789181\"},{\"id\":\"3\",\"server_id\":\"10\",\"name\":\"internal\",\"extras\":\"[]\",\"description\":null,\"timestamp\":\"1374686650\"}]"}]}

ERROR:

{"success":0, "message":"error message"}

Data Detail:

Name	Type	Name	Type	Example	Description
id	INTEGER15	Server ID
The server id to fetch.

STRING

URL

/api/v1/api.php?target=dnsServer&action=add

Description

Adds a new DNS Server

Returns

Examples:

SUCCESSFUL:	{"success":1,"message":"Add Successful."}
ERROR:	{"success":0, "message":"error message"}

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

Name	Type	Example	Description
customerName	STRING	/tmp/zones	Customer Name
remoteDirectory	STRING	/tmp/zones	Zone Directory on Server
namedConfPath	STRING	/tmp	Zone Path
preCommand	STRING	/path/to/stuff/precommand
postCommand	STRING	/path/to/stuff/postcommand

delete

URL

/api/v1/api.php?target=dnsServer&action=delete

Description

Deletes a DNS Server

Returns

Examples:

SUCCESSFUL:	{"success":1,"message":"Delete Successful."}
ERROR:	{"success":0, "message":"error message"}

Required Parameters

Name	Type	Example	Description
id	NUMERIC	5	ID of server to delete.

Example URL

/api/v1/api.php?target=dnsServer&action=delete&id=5

Server Name
username	STRING	Login Name
password	CRYPT	Login Password
port	INTEGER	Port the Server listens on
zoneCount	INTEGER	The number of zones attached to this server.
options	JSON	The options entry is a JSON-encoded string containing a variety of server-specific configuration options. This string will vary widely by server type and configuration. The following are a selection of common settings.
transfer_type	STRING	Protocol used for transfer of DNS zones and records. Valid settings include SCP, PowerDNS, Secure64, Secure64Signer
server_type	STRING	Whether this server is a master or a slave server
SOA	STRING	The SOA entry to be used for zones on this server
remote_directory	STRING	The directory where SCP will place the zone files.
named_conf_path	STRING	The path to the zone files used within the named.conf file.
pre_command	STRING	The command executed on the server before the zones are transferred
post_command	STRING	The command executed on the server after the transfer is complete
enable_views	INTEGER	Whether or not Views are enabled
views	JSON	The views entry is a JSON-encoded string containing all the information about the Views attached to this server, if any exist.
id	INTEGER	The View ID
server_id	INTEGER	The ID of the server the View is attached to
name	STRING	The name of the View
description	STRING	A description of the View
timestamp	INTEGER	The UNIX timestamp of when the view was created.
extras	JSON	A JSON-encoded array of the extra attributes printed out in the view definition in the config file.

Required Parameters

None

Optional Parameters

Name	Type	Example	Description
id	INTEGER	15	The server id to fetch.

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:

SUCCESSFUL:	{"success":1,"message":"Add Successful."}
ERROR:	{"success":0, "message":"error message"}

Required Parameters

Name	Type	Example	Description
server	STRING	dns.yourdomain.com	IP or FQDN of the DNS Server
password	STRING	password1	Login password for Server
transferType	STRING	SCP	Protocol used for transfer of DNS zones and records. Valid settings include SCP, PowerDNS, Secure64, Secure64Signer
serverType	STRING	Master	Values are 'Master' or 'Slave' only
displayName	STRING	Primary NS	The name displayed representing the DNS server, can be the same as server or different
SOA	STRING	ns1.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.

Name	Type	Example	Description
customerName	STRING	/tmp/zones	Customer Name
remoteDirectory	STRING	/tmp/zones	Zone Directory on Server
port	INTEGER	22	Port for ssh or scp access to server
namedConfPath	STRING	/tmp	The path to the zone files used within the named.conf file.
preCommand	STRING	/path/to/stuff/precommand	Command to execute before zone transfer
postCommand	STRING	/path/to/stuff/postcommand	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

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:

SUCCESSFUL:	{"success":1,"message":"Delete Successful."}
ERROR:	{"success":0, "message":"error message"}

Required Parameters

Name	Type	Example	Description
id	INTEGER	5	ID of server to delete

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:

SUCCESSFUL:	{"success":1,"message":"Update Successful."}
ERROR:	{"success":0, "message":"error message"}

Required Parameters

Name	Type	Example	Description
id	INTEGER	5	ID of server
server	STRING	dns.yourdomain.com	IP or FQDN of the DNS Server
SOA	STRING	ns1.6connect.com. hostmaster.6connect.com.	Server of Authority record for DNS server
transferType	STRING	SCP	Protocol used for transfer of DNS zones and records. Valid settings include SCP, PowerDNS, Secure64, Secure64Signer

Optional Parameters

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

Name	Type	Example	Description
active	INTEGER	0	Values 0 or 1 only, sets the server to inactive on 0 value
customerName	STRING	/tmp/zones	Customer Name
dbDatabaseName	STRING	pdns_1	DB name for pDNS servers with MySQL powerDNSBackend type
dbPassword	STRING	somepass	DB password 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
displayName	STRING	Primary NS	The name displayed representing the DNS server, can be the same as server or different
DNSSECContact	STRING	joeuser	For use with Dyn dns service
enable_views	INTEGER	1	Whether or not Views are enabled. Valid values are '1' for enable or '0' for do not enable
masterId	INTEGER	53	Master server ID. If a server is a slave, masterId points to its master.
namedConfPath	STRING	/tmp	The path to the zone files used within the named.conf file.
password	STRING	password1	Login password for Server
port	INTEGER	22	Port for ssh or scp access to server
powerDNSBackend	STRING	Bind or MySQL	pDNS server backend type
postCommand	STRING	/path/to/stuff/postcommand	Command to execute after zone transfer
preCommand	STRING	/path/to/stuff/precommand	Command to execute before zone transfer
remoteDirectory	STRING	/tmp/zones	Zone Directory on Server
serverType	STRING	Master	Values are 'Master' or 'Slave' only
username	STRING	bobuser	Login name for Server

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:

SUCCESSFUL:	{"success":1,"message":"Transfer Successful."}
ERROR:	{"success":0, "message":"error message"}

Required Parameters

Name	Type	Example	Description
push	INTEGER	1	The ID of the server to push zones to

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:

SUCCESSFUL:	{"success":1,"message":"Updated Zone: $name.zone on $server via SCP"}
ERROR:	{"success":0, "message":"error message"}

Required Parameters

Name	Type	Example	Description
zoneId	INTEGER	35	The ID of the zone to push

Optional Parameters

None

Example URL

/api/v1/api.php?target=dnsServer&action=transferSingle&zoneId=35

DNS Zone Control

Examples:

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:

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, "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}]

update

URL

/api/v1/api.php?target=dnsServer&action=update

Description

Updates an existing DNS Server with new information.

Returns

Examples:

SUCCESSFUL:	{"success":1,"message":"Update Successful."}
ERROR:	{"success":0, "message":"error message"}

Required Parameters

Name	Type	Example	Description
username	STRING	bobuser	Login name for Server
password	STRING	password1	Login password for Server
transferType	STRING	SCP	Protocol

Optional Parameters

Name	Type	Example	Description
customerName	STRING	/tmp/zones	Customer Name
remoteDirectory	STRING	/tmp/zones	Zone Directory on Server
namedConfPath	STRING	/tmp	Zone Path
preCommand	STRING	/path/to/stuff/precommand
postCommand	STRING	/path/to/stuff/postcommand

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"}

Data Detail:

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?

Name	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.

Name	Type	Example	Description
updateZoneName	STRING	foo	The Zone name to replace into the searched rows.
updateZoneResourceId	INT	5	The Resource Id to replace into the searched rows.
updateZoneSerial	INT	2012033001	The Zone Serial to replace into the searched rows.
updateZoneRefresh	INT	36000	The Zone Refresh to replace into the searched rows.
updateZoneRetry	INT	800	The Zone Retry to replace into the searched rows..
updateZoneExpire	INT	6090000	The Zone Expire to replace into the searched rows.
updateZoneMinimum	INT	10	The Zone Minimum to replace into the searched rows.
updateZoneSOA	STRING	200	The Zone SOA to replace into the searched rows.
updateZoneTags	STRING	client,production	Zone Tags to replace into the searched rows.
updateZoneTTL	INT	3600	The Zone TTL to replace into the searched rows.
updateZoneEnableDNSSEC	INT	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.

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.

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.

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.
zoneIpver	STRING	IPv6	The IP Version.
zoneLocalSigning	BOOL	1	Whether or not this zone should be signed by the ProVision server when DNSSEC is enabled. If set to false, ProVision will deliver the zone unsigned to the DNS server and the signing / updating process should be triggered by the post-push command
zoneSerial	INTEGER	2012033001	Serial for the new Zone.
zoneRefresh	INTEGER	36000	Refresh for the new Zone.
zoneRetry	INTEGER	800	Retry for the new Zone.
zoneExpire	INTEGER	6090000	Expire for the new Zone.
zoneMinimum	INTEGER	10	Minimum for the new Zone.
zoneSOA	STRING	200	SOA for the new Zone.
zoneTTL	STRING	3600	TTL for the new Zone.
zoneEnableDNSSEC	INTEGER	1	Whether or not this new zone uses DNSSEC.

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.

SUCCESSFUL:	{"success":1,"message":"Zones and Associated Records Deleted."}
ERROR:	{"success":0, "message":"error message"}

Page tree

Page History

Versions Compared

Old Version 2

New Version Current

Key

DNS Server Control

get

add

delete

update

transferServer

transferSingle

DNS Zone Control

get

DNS Zone Control

search

update

add

delete

getRecordTypes

getFile

getDSFile

checkZone

getArchivedZone

DNS Record Control

get

update

add

delete

switch

Server-Zone Linkage

get

add

delete

Name Server Control

get

add

delete

setDefault

orderUp

orderDown