InterWorx API
Part I: InterWorx API Overview
Chapter 1: Introduction
Section: The Two API’s
Section: Authentication
Chapter 2: Using the API
Section 2.1: PHP Example Usage
Section 2.2: Perl Example Usage
Part II: NodeWorx API Spec
Chapter 3: Controller: /nodeworx/apikey
Chapter 4: Controller: /nodeworx/backup
Chapter 5: Controller: /nodeworx/cluster
Chapter 6: Controller: /nodeworx/cluster/lb
Chapter 7: Controller: /nodeworx/cluster/nodes
Chapter 8: Controller: /nodeworx/command/queue
Chapter 9: Controller: /nodeworx/cron
Chapter 10: Controller: /nodeworx/dns
Chapter 11: Controller: /nodeworx/dns/record
Chapter 12: Controller: /nodeworx/dns/sync
Chapter 13: Controller: /nodeworx/dns/zone
Chapter 14: Controller: /nodeworx/firewall
Chapter 15: Controller: /nodeworx/ftp
Chapter 16: Controller: /nodeworx/health
Chapter 17: Controller: /nodeworx/help
Chapter 18: Controller: /nodeworx/http
Chapter 19: Controller: /nodeworx/index
Chapter 20: Controller: /nodeworx/ip
Chapter 21: Controller: /nodeworx/ip/sites
Chapter 22: Controller: /nodeworx/ipv6
Chapter 23: Controller: /nodeworx/lang
Chapter 24: Controller: /nodeworx/logout
Chapter 25: Controller: /nodeworx/logs
Chapter 26: Controller: /nodeworx/mail/imap
Chapter 27: Controller: /nodeworx/mail/mda
Chapter 28: Controller: /nodeworx/mail/mta
Chapter 29: Controller: /nodeworx/mail/pop3
Chapter 30: Controller: /nodeworx/mail/queue
Chapter 31: Controller: /nodeworx/mail/send
Chapter 32: Controller: /nodeworx/mail/simap
Chapter 33: Controller: /nodeworx/mail/smtp
Chapter 34: Controller: /nodeworx/mail/smtp2
Chapter 35: Controller: /nodeworx/mail/spam
Chapter 36: Controller: /nodeworx/mail/spop3
Chapter 37: Controller: /nodeworx/mail/virus
Chapter 38: Controller: /nodeworx/mysql
Chapter 39: Controller: /nodeworx/mysql/phpmyadmin
Chapter 40: Controller: /nodeworx/mysql/remote
Chapter 41: Controller: /nodeworx/nfs
Chapter 42: Controller: /nodeworx/nfs/export
Chapter 43: Controller: /nodeworx/nfs/mount
Chapter 44: Controller: /nodeworx/notice
Chapter 45: Controller: /nodeworx/overview
Chapter 46: Controller: /nodeworx/packages
Chapter 47: Controller: /nodeworx/plugins
Chapter 48: Controller: /nodeworx/reseller
Chapter 49: Controller: /nodeworx/reseller/bandwidthhistory
Chapter 50: Controller: /nodeworx/reseller/packages
Chapter 51: Controller: /nodeworx/rrd
Chapter 52: Controller: /nodeworx/settings
Chapter 53: Controller: /nodeworx/shell
Chapter 54: Controller: /nodeworx/simplescripts
Chapter 55: Controller: /nodeworx/siteworx
Chapter 56: Controller: /nodeworx/sshd
Chapter 57: Controller: /nodeworx/ssl
Chapter 58: Controller: /nodeworx/themes
Chapter 59: Controller: /nodeworx/twofactorauth
Chapter 60: Controller: /nodeworx/updates
Chapter 61: Controller: /nodeworx/users
Part III: SiteWorx API Spec
Chapter 62: Controller: /siteworx/backup
Chapter 63: Controller: /siteworx/backup/schedule
Chapter 64: Controller: /siteworx/cron
Chapter 65: Controller: /siteworx/dns
Chapter 66: Controller: /siteworx/domains/php
Chapter 67: Controller: /siteworx/domains/pointer
Chapter 68: Controller: /siteworx/domains/slave
Chapter 69: Controller: /siteworx/domains/sub
Chapter 70: Controller: /siteworx/email
Chapter 71: Controller: /siteworx/email/alias
Chapter 72: Controller: /siteworx/email/autorespond
Chapter 73: Controller: /siteworx/email/box
Chapter 74: Controller: /siteworx/email/domainkeys
Chapter 75: Controller: /siteworx/email/filters
Chapter 76: Controller: /siteworx/email/group
Chapter 77: Controller: /siteworx/email/remotesetup
Chapter 78: Controller: /siteworx/email/spamprefs
Chapter 79: Controller: /siteworx/email/spf
Chapter 80: Controller: /siteworx/ftp
Chapter 81: Controller: /siteworx/ftp/sessions
Chapter 82: Controller: /siteworx/htaccess
Chapter 83: Controller: /siteworx/index
Chapter 84: Controller: /siteworx/logout
Chapter 85: Controller: /siteworx/logs
Chapter 86: Controller: /siteworx/mysql/db
Chapter 87: Controller: /siteworx/mysql/perms
Chapter 88: Controller: /siteworx/mysql/user
Chapter 89: Controller: /siteworx/notice
Chapter 90: Controller: /siteworx/overview
Chapter 91: Controller: /siteworx/prefs
Chapter 92: Controller: /siteworx/simplescripts
Chapter 93: Controller: /siteworx/ssl
Chapter 94: Controller: /siteworx/ssl/chain
Chapter 95: Controller: /siteworx/ssl/crt
Chapter 96: Controller: /siteworx/ssl/csr
Chapter 97: Controller: /siteworx/ssl/key
Chapter 98: Controller: /siteworx/twofactorauth
Chapter 99: Controller: /siteworx/users
 Chapter 11: Controller: /nodeworx/dns/record Up Part II: NodeWorx API Spec Chapter 13: Controller: /nodeworx/dns/zone 

12 Controller: /nodeworx/dns/sync

Required Permissions "DNS"
Action: add
Added in version 4.7.0-339
Description Add a DNS syncronization server.
Input Parameters 
Name Type Notes Required?
hostname string Help Entry
The hostname of the InterWorx server which should poll this server for DNS data
 Yes
apikey string Help Entry
The API Key from the InterWorx server which should poll this server for DNS data
 Yes
test integer Example Values
1, 0
Example Default Value
1
 No*
* 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: reroute
Added in version n/a
Description Action to re-route from the current controller to a different one.
Action: win
Added in version n/a
Description Magic function - test for testing success mechanism.
 Chapter 11: Controller: /nodeworx/dns/record Up Part II: NodeWorx API Spec Chapter 13: Controller: /nodeworx/dns/zone 

(C) 2018 by InterWorx LLC