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

Required?

Example Values

Default Values

Notes

domain

string

Yes

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.

ipaddr

string

Yes

IPv4 address to use for variable replacement in DNS Templates.

ipv6_address

string

No

IPv6 address to use for variable replacement in DNS Templates.

email

string

No

Email address to use for variable replacement in DNS Templates.

Action: delete

Added in Version

4.7.0-339

Description

Delete a DNS Zone.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

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

Required?

Example Values

Default Values

Notes

zone_id

integer

Yes

nameserver

string

No*

{domain}

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. - Leave blank for default

contact

string

No*

hostmaster@{domain}

This is the email address listed on your SOA record. Enter it as a normal email address (user@domain.com) and not in the typical SOA style of (user.domain.com). - Leave blank for default

refresh

integer

No*

7200

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). - In Seconds

retry

integer

No*

300

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). - In Seconds

expire

integer

No*

1209600

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. - In Seconds

negative_ttl

integer

No*

10800

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. - In Seconds

* indicates that it’s actually required, but probably already has a valid default value.

Action: fail

Added in Version

n/a

Description

Magic function - test for failure mechanism.

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 => '3',
      1 => '2.dns-template.com',
    ),
    2 =>
    array (
      0 => '2',
      1 => 'example.com',
    ),
  ),
  'reply_code' => 205,
)

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' => '2',
      'domain' => 'example.com',
      'nodeworx_id' => '1',
      'is_template' => '0',
      'record_count' => '19',
      'is_suspended' => '0',
      'domain_type' => 'master',
      'master_domain' => 'example.com',
    ),
    2 =>
    array (
      'zone_id' => '4',
      'domain' => 'pointer.com',
      'nodeworx_id' => '1',
      'is_template' => '0',
      'record_count' => '9',
      'is_suspended' => '0',
      'domain_type' => 'redirect',
      'master_domain' => 'example.com',
    ),
  ),
  'reply_code' => 205,
)

Action: queryZones

Added in Version

4.8.0-393

Description

Search for DNS Zones for a given domain or domains.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

nodeworx_id

string

No

domain

struct (string)

No

example.com, pointer.com, secondary.com

Action: reroute

Added in Version

n/a

Description

Action to re-route from the current controller to a different one.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

controller

string

Yes

Index, Overview, Users, Lang, Apikey, Plugins, Twofactorauth, Notice, Siteworx, Shell, Packages, Backup, Import, Softaculous, Reseller, ResellerPackages, ResellerBandwidthhistory, Http, Phpextensions, Ftp, Sshd, MailMta, MailSmtp, MailSmtp2, MailSend, MailMda, MailMsa, MailDovecot, MailSpam, MailVirus, MailMailman, MailQueue, Mysql, MysqlRemote, MysqlPhpmyadmin, Dns, DnsZone, DnsRecord, DnsSync, Nfs, NfsExport, NfsMount, Health, Cron, Firewall, Ssl, Logs, Settings, Updates, Rrd, …

Action: suspend

Added in Version

4.7.0-339

Description

Suspend a DNS Zone.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

zone_id

struct (integer)

Yes

Action: unsuspend

Added in Version

4.7.0-339

Description

Unsuspend a DNS Zone.

Input Parameters

Name

Type

Required?

Example Values

Default Values

Notes

zone_id

struct (integer)

Yes

Action: win

Added in Version

n/a

Description

Magic function - test for testing success mechanism.