Page History

...

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	INT	Server ID
server	STRING	Server Name
username	STRING	Login Name
password	CRYPT	Login Password
port	INT	Port the Server listens on
zoneCount	INT	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	The type of server this is. 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 file location files used when writing the server configuration filewithin the named.conf file.
pre_command	STRING	The command executed on the server before the zones are transfered
post_command	STRING	The command executed on the server after the transfer is complete
enable_views	INT	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	INT	The View ID
server_id	INT	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	INT	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.

Optional Parameters

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

...

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

There 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
namedConfPath	STRING	/tmpZone Path	The path to the zone files used within the named.conf file.
preCommand	STRING	/path/to/stuff/precommand
postCommand	STRING	/path/to/stuff/postcommand

...

Page tree

Versions Compared

Old Version 10

New Version 11

Key