HTML

<div id="google_translate_element"></div>
<script type="text/javascript">
function googleTranslateElementInit() {
  new google.translate.TranslateElement({pageLanguage: 'en'}, 'google_translate_element');
}
</script>
<script type="text/javascript" src="//translate.google.com/translate_a/element.js?cb=googleTranslateElementInit"></script>

DNS Server Control

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

Table of Contents

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:

SUCCESSFUL:

{"success":1,"message":"Fetch Sucessful.","data":[{"id":"10","server":"mrbomasm-dns-4.onnet.net", "username":"user", "password":"vwvddp","port":"2600","customer_name":null,"transfer_type": "SCP","remote_directory":"zones", "named_conf_path":"\/etc\/zones","active":"1","post_command":null,"pre_command":null,"dyn_DNSSEC_contact":null, "powerdns_backend":"Bind","db_username":null,"db_password":"(","db_port":null,"db_name":null, "server_type":"slave","SOA":null,"master_id":null,"options": "{\"customer_name\":\"\",\"server_type\":\"slave\" ,\"SOA\":\"\",\"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	Description
id	INTEGER	Server ID
server	STRING	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

...

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:

SUCCESSFUL:	{"success":1,"message":"Search Successful.","data":[{"recordId":"30894","recordZoneId":"229","recordHost":"@","recordType":"NS","recordValue":"ns1.domain.com.","recordDescription":"","recordTTL":""}]}
ERROR:	{"success":0, "message":"error message"}

Data Detail:

Name	Type	Description
recordId	INTEGER	The ID of this Record Entry. It is always included with its parent Zone.
recordZoneId	INTEGER	The ID of this Record's 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.

Required Parameters

None

Optional Parameters

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.
selectCount	INTEGER	30	When supplied only returns the first X entries
selectOffset	INTEGER	10	When supplied, only returns entries after record X

Name	Type	Example	Description
recordId	INTEGER	123	The Record ID to search for.
recordZoneId	INTEGER	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.

Name	Type	Example	Description
zoneId	INTEGER	123	The Zone Id to search for.
zoneName	STRING	foo	The Zone Name to search for.
zoneResourceId	INTEGER	5	The Resource Id to search for.
zoneCustName	STRING	foo	The Customer Name to search for.
zoneIpver	STRING	IPv6	The IP Version to search for.
zoneSerial	INTEGER	2012033001	The Zone Serial to search for.
zoneRefresh	INTEGER	36000	The Zone Refresh to search for.
zoneRetry	INTEGER	800	The Zone Retry to search for.
zoneExpire	INTEGER	6090000	The Zone Expire to search for.
zoneMinimum	INTEGER	10	The Zone Minimum to search for.
zoneSOA	STRING	200	The Zone SOA to search for.
zoneTTL	INTEGER	3600	The Zone TTL to search for.
zoneEnableDNSSEC	INTEGER	1	Search based on DNSSEC settings.

Example URL

/api/v1/api.php?target=record&action=get&selectCount=30&zoneId=123

...

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:

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

Required Parameters

Name	Type	Example	Description
id	INTEGER	5	ID of server to activate.

Optional Parameters

None

Example URL

/api/v1/api.php?target=nameServer&action=orderDown&id=5

...

Page tree

Versions Compared

Old Version 24

New Version 25

Key

DNS Server Control

DNS Server Control

get

add

delete

get

orderDown

Page tree

Page History

Versions Compared

Old Version 24

New Version 25

Key

DNS Server Control

DNS Server Control

get

add

delete

get

orderDown