Chapter 12: Controller: /nodeworx/dns/sync Up Part II: NodeWorx API Spec Chapter 14: Controller: /nodeworx/firewall 

13 Controller: /nodeworx/dns/zone

Required Permissions "DNS"
Action: add
Added in version 4.7.0-339
Description Add a DNS Zone.
Input Parameters
Name Type Notes Required?
domain string Help Entry
Enter the domain you would like to do DNS for in this box. Be sure that you DO NOT include the ’www’ prefix. The domain should be in the format: yourdomain.com. All top level domain (TLD) extensions are valid (i.e. yourdomain.co.uk).<br /><br />NOTE: If you are editing the zone after its creation, you will not be able to change the domain name; you will have to delete it and create a new one.
Yes
ipaddr string Help Entry
IPv4 address to use for variable replacement in DNS Templates.
Yes
ipv6_address string Help Entry
IPv6 address to use for variable replacement in DNS Templates.
No
email string Help Entry
Email address to use for variable replacement in DNS Templates.
No
Action: delete
Added in version 4.7.0-339
Description Delete a DNS Zone.
Input Parameters
Name Type Notes Required?
zone_id struct (integer) Yes
Action: edit
Added in version 4.7.0-339
Description Edit a DNS Zone SOA information.
Warning This action has been deprecated as of version 4.8.0-393. 2011-03-21 Use Ctrl_Nodeworx_DnsRecord::editSOA() instead
Input Parameters
Name Type Notes Required?
zone_id integer Yes
nameserver string Description
Leave blank for default
Help Entry
Enter the primary nameserver of your domain. This will almost always be handled automatically for you when creating SiteWorx accounts, and you are urged to only alter this value if you know what you are doing. This nameserver is listed on your SOA record for this domain, and setting it to an incorrect value could cause your site or any of your DNS records not to function properly.
Example Default Value
{domain}
No*
contact string Description
Leave blank for default
Help Entry
This is the e-mail address listed on your SOA record. Enter it as a normal e-mail address (user@domain.com) and not in the typical SOA style of (user.domain.com).
Example Default Value
testmaster@{domain}
No*
refresh integer Description
In Seconds
Help Entry
Sets the number of seconds that a slave will cache the record before re-checking the primary server. Recommended values are between 1200 (twenty minutes) and 43200 (twelve hours).
Example Default Value
7200
No*
retry integer Description
In Seconds
Help Entry
Set the number of seconds to retry a refresh after the previous refresh attempt fails. Recommended values are between 180 (three minutes) and 900 (fifteen minutes).
Example Default Value
300
No*
expire integer Description
In Seconds
Help Entry
Set the number of seconds for refresh and retry attempts before the server will stop serving the zone. Per RFC 1912, recommended values are between 1209600 (two weeks) and 2419200 (four weeks). This value is only used by slave servers.
Example Default Value
1209600
No*
negative_ttl integer Description
In Seconds
Help Entry
Time in seconds for negative answers (NXDOMAIN) from this zone. This field was redefined in 1998 by RFC2308. Suggested values are between 3600 (one hour) and 10800 (three hours). Values higher than 86400 (twenty-four hours) should be avoided.
Example Default Value
10800
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: listZoneIds
Added in version 4.7.0-339
Description List dns zones by id.
Warning This action has been deprecated as of version 4.7.1-343. 2010-12-10 use listZonesAction
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
0 => ’1’,
1 => ’1.dns-template.com’,
),
1 =>
array (
0 => ’231’,
1 => ’16.dns-template.com’,
),
2 =>
array (
0 => ’639’,
1 => ’example.com’,
),
),
)
Action: listZones
Added in version 4.8.0-393
Description Lists all DNS Zones.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’zone_id’ => ’1’,
’domain’ => ’1.dns-template.com’,
’nodeworx_id’ => ’1’,
’is_template’ => ’1’,
’record_count’ => ’11’,
’is_suspended’ => ’0’,
’domain_type’ => NULL,
’master_domain’ => NULL,
),
1 =>
array (
’zone_id’ => ’640’,
’domain’ => ’pointer.com’,
’nodeworx_id’ => ’1’,
’is_template’ => ’0’,
’record_count’ => ’9’,
’is_suspended’ => ’0’,
’domain_type’ => ’redirect’,
’master_domain’ => ’example.com’,
),
2 =>
array (
’zone_id’ => ’641’,
’domain’ => ’secondary.com’,
’nodeworx_id’ => ’1’,
’is_template’ => ’0’,
’record_count’ => ’9’,
’is_suspended’ => ’0’,
’domain_type’ => ’slave’,
’master_domain’ => ’example.com’,
),
),
)
Action: queryZones
Added in version 4.8.0-393
Description Search for DNS Zones for a given domain or domains.
Input Parameters
Name Type Notes Required?
nodeworx_id string No
domain struct (string) Example Values
example.com, pointer.com, secondary.com
No
Action: suspend
Added in version 4.7.0-339
Description Suspend a DNS Zone.
Input Parameters
Name Type Notes Required?
zone_id struct (integer) Yes
Action: unsuspend
Added in version 4.7.0-339
Description Unsuspend a DNS Zone.
Input Parameters
Name Type Notes Required?
zone_id struct (integer) Yes
 Chapter 12: Controller: /nodeworx/dns/sync Up Part II: NodeWorx API Spec Chapter 14: Controller: /nodeworx/firewall 

(C) 2017 by InterWorx LLC