API Table of Contents

Jump to SiteWorx

NodeWorx API

Apikey
- delete - Delete API Key.
- generate - Generates a new API Key.
- listApikey - List the installed API Key.
Backup
- fullbackup - Creates a full backup for the specified domains.
- queryAccounts - Query the backups based on the selected reseller.
- queryBackups - Get a list of backups given a domain.
- restore - Restore a given backup (local).
- structureonly - Creates a structure only backup for the specified domains.
ClusterLb
- addService - Add load balancing to a service.
- deleteService - Delete loadbalancing of a service.
- editService - Edit a clustered service.
- isRunning - Checks if the service is running or not.
- isRunningOnNode - Checks if the service is running on a specific node (Clustering only).
- listCurrentLoadBalancerStatus - Lists the current load balancer status.
- listGeneralName - Lists the "normal" name - ie "web server" instead of "httpd".
- listPortNumbers - Lists a string of the port numbers that this service uses, comma-seperated.
- listPortNumbersArray - Lists array of port numbers and ranges that this service uses.
- listRequiredPermissions - Lists an array of permissions required to control the service.
- listServiceInfo - Lists the service name, ports, page, and status.
- listServiceName - Lists the service name - ie "httpd" instead of "web server".
- listServicePage - Lists the page that controls the service.
- restart - Restarts the service.
- restartOnNode - Restarts the service on a specific node (Clustering only).
- settings - Modify ldirectord variables.
- start - Starts the service.
- startOnBoot - Set the loadbalancer start on boot status.
- startOnNode - Starts the service on a specific node (Clustering only).
- stop - Stops the service.
- stopOnNode - Stops the service on a specific node (Clustering only).
ClusterNodes
- add - Add a cluster node.
- delete - Delete a cluster node.
- forceDelete - Force deletion of a cluster node, even if the cluster manager cannot reach it.
- listClusterNodes - List cluster nodes.
CommandQueue
- isRunning - Checks if the service is running or not.
- isRunningOnNode - Checks if the service is running on a specific node (Clustering only).
- listGeneralName - Lists the "normal" name - ie "web server" instead of "httpd".
- listPortNumbers - Lists a string of the port numbers that this service uses, comma-seperated.
- listPortNumbersArray - Lists array of port numbers and ranges that this service uses.
- listRequiredPermissions - Lists an array of permissions required to control the service.
- listServiceInfo - Lists the service name, ports, page, and status.
- listServiceName - Lists the service name - ie "httpd" instead of "web server".
- listServicePage - Lists the page that controls the service.
- queryCommandHistory - View history of the command queue.
- queryQueuedCommands - Query the command queue on a node.
- restart - Restarts the service.
- restartOnNode - Restarts the service on a specific node (Clustering only).
- start - Starts the service.
- startOnNode - Starts the service on a specific node (Clustering only).
- stop - Stops the service.
- stopOnNode - Stops the service on a specific node (Clustering only).
Cron
- add - Add a job to a user's crontab.
- edit - Edit a cronjob on a user's crontab.
- options - Manage options for cron users.
Dns
- defaultServers - Set the default nameserver (NS) records for new domains.
- flush - DNS flush service action.
- install - Installs a DNS server on IPs that don't have one.
- isRunning - Checks if the service is running or not.
- isRunningOnNode - Checks if the service is running on a specific node (Clustering only).
- listDnsServices - Lists information about DNS Services running.
- listGeneralName - Lists the "normal" name - ie "web server" instead of "httpd".
- listPortNumbers - Lists a string of the port numbers that this service uses, comma-seperated.
- listPortNumbersArray - Lists array of port numbers and ranges that this service uses.
- listRequiredPermissions - Lists an array of permissions required to control the service.
- listServiceInfo - Lists the service name, ports, page, and status.
- listServiceName - Lists the service name - ie "httpd" instead of "web server".
- listServicePage - Lists the page that controls the service.
- listServiceStatus - Lists information about DNS Services running.
- listUnmappedIps - Lists information about IPs that do not have DNS running.
- remove - DNS remove service action.
- restart - DNS restart service action.
- restartOnNode - Restarts the service on a specific node (Clustering only).
- setSoaSerialFormat - Set the DNS SOA Serial Format.
- start - DNS start service action.
- startOnNode - Starts the service on a specific node (Clustering only).
- stop - DNS stop service action.
- stopOnNode - Stops the service on a specific node (Clustering only).
- zoneDefaults - Update the default dns zone settings.
DnsRecord
- ~~add~~ - 2011-02-23 Use the individual add(record-type) functions instead. DEPRECATED in version 4.8.0-393
- addA - Add an A record to a zone.
- addAAAA - Add an AAAA record to a zone.
- addCNAME - Add a CNAME record to a zone.
- addMX - Add an MX record to a zone.
- addNAPTR - Add an NAPTR record to a zone.
- addNS - Add an NS record to a zone.
- addPTR - Add a PTR record to a zone.
- addSOA - Add an SOA record to a zone.
- addSPF - Add an SPF record to a zone.
- addSRV - Add an SRV record to a zone.
- addTXT - Add a TXT record to a zone.
- delete - Delete a DNS record.
- ~~edit~~ - 2011-02-23 Use the individual edit(record-type) functions instead. DEPRECATED in version 4.8.0-393
- editA - Edit an A record.
- editAAAA - Edit an AAAA record.
- editCNAME - Edit a CNAME record.
- editMX - Edit a MX record.
- editNAPTR - Edit a NAPTR record.
- editNS - Edit a NS record.
- editPTR - Edit a PTR record.
- editSOA - Edit an SOA record.
- editSPF - Edit an SPF record.
- editSRV - Edit an SRV record.
- editTXT - Edit a TXT record.
- ~~listRecordIds~~ - 2009-12-07 use listRecords DEPRECATED in version 4.1.0-247
- listRecords - List dns records by id.
- queryRecords - Query DNS Records.
DnsSync
- add - Add a DNS syncronization server.
DnsZone
- add - Add a DNS Zone.
- delete - Delete a DNS Zone.
- ~~edit~~ - 2011-03-21 Use Ctrl_Nodeworx_DnsRecord::editSOA() instead DEPRECATED in version 4.8.0-393
- ~~listZoneIds~~ - 2010-12-10 use listZonesAction DEPRECATED in version 4.7.1-343
- listZones - Lists all DNS Zones.
- queryZones - Search for DNS Zones for a given domain or domains.
- suspend - Suspend a DNS Zone.
- unsuspend - Unsuspend a DNS Zone.
Firewall
- addPort - Add a port to the firewall configuration.
- allowDenyIps - Set firewall ip address allow and deny lists.
- delete - Delete firewall port configuration.
- isRunning - Checks if the service is running or not.
- isRunningOnNode - Checks if the service is running on a specific node (Clustering only).
- listGeneralName - Lists the "normal" name - ie "web server" instead of "httpd".
- listPortNumbers - Lists a string of the port numbers that this service uses, comma-seperated.
- listPortNumbersArray - Lists array of port numbers and ranges that this service uses.
- listRequiredPermissions - Lists an array of permissions required to control the service.
- listServiceInfo - Lists the service name, ports, page, and status.
- listServiceName - Lists the service name - ie "httpd" instead of "web server".
- listServicePage - Lists the page that controls the service.
- restart - Restarts the service.
- restartOnNode - Restarts the service on a specific node (Clustering only).
- start - Starts the service.
- startOnBoot - Set the firewall start-on-boot status.
- startOnNode - Starts the service on a specific node (Clustering only).
- stop - Stops the service.
- stopOnNode - Stops the service on a specific node (Clustering only).
- updateConfig - Update basic firewall configuration.
Ftp
- autoRestart - Set the FTP server auto-restart status.
- isRunning - Checks if the service is running or not.
- isRunningOnNode - Checks if the service is running on a specific node (Clustering only).
- killSessions - Kill ftp sessions.
- listFtpSessions - List Ftp Sessions.
- listGeneralName - Lists the "normal" name - ie "web server" instead of "httpd".
- listPortNumbers - Lists a string of the port numbers that this service uses, comma-seperated.
- listPortNumbersArray - Lists array of port numbers and ranges that this service uses.
- listRequiredPermissions - Lists an array of permissions required to control the service.
- listServiceInfo - Lists the service name, ports, page, and status.
- listServiceName - Lists the service name - ie "httpd" instead of "web server".
- listServicePage - Lists the page that controls the service.
- restart - Restarts the service.
- restartOnNode - Restarts the service on a specific node (Clustering only).
- rrdGraph - Set the FTP connections RRD graph display in the web interface.
- serverOptions - Update FTP server settings.
- sftpOptions - Update SFTP server settings.
- start - Starts the service.
- startOnBoot - Set the FTP server start-on-boot status.
- startOnNode - Starts the service on a specific node (Clustering only).
- stop - Stops the service.
- stopOnNode - Stops the service on a specific node (Clustering only).
Health
- edit - Edit Problem settings - action has conditional inputs not documented.
- editRecipients - Change the recipients of a code.
- listHealthStatus - Lists real-time status of detectors (actually runs each, be careful about load).
- queryCodeHistory - Get the code history for a specific code.
- queryCodesByEmail - Lists codes that the given email address may recieve.
- removeTargetFromCode - Removes a specific target from a code. Use queryCodesByEmail() to see targets.
Help
- ssh - Enable or disable Interworx Support SSH user.
Http
- apacheUpdate - Update common apache web server settings.
- autoRestart - Set the web server auto-restart status.
- disable - Http disable Apache module action.
- enable - Http enable Apache module action.
- isRunning - Checks if the service is running or not.
- isRunningOnNode - Checks if the service is running on a specific node (Clustering only).
- listGeneralName - Lists the "normal" name - ie "web server" instead of "httpd".
- listModules - List Apache module information.
- listPortNumbers - Lists a string of the port numbers that this service uses, comma-seperated.
- listPortNumbersArray - Lists array of port numbers and ranges that this service uses.
- listRequiredPermissions - Lists an array of permissions required to control the service.
- listServiceInfo - Lists the service name, ports, page, and status.
- listServiceName - Lists the service name - ie "httpd" instead of "web server".
- listServicePage - Lists the page that controls the service.
- remove - Http remove Apache module action.
- restart - Restarts the service.
- restartOnNode - Restarts the service on a specific node (Clustering only).
- start - Starts the service.
- startOnBoot - Set the web server start-on-boot status.
- startOnNode - Starts the service on a specific node (Clustering only).
- stop - Stops the service.
- stopOnNode - Stops the service on a specific node (Clustering only).
- updatePhpMode - Set php installation mode.
- updateRrd - Show or hide the web server connections RRD graph in the web interface.
Index
- getSession - Gets the session id.
Ip
- add - Add an ip address range.
- listIpv4Addresses - List ipv4 addresses on the system.
IpSites
- defaultSitesStatus - Change the status of the Default Sites feature.
- listIpDefaultSites - List the sites IPs redirect to when requested like http://ip.ad.dr.es/.
- updateIpDefaultSites - Change the locations IPs redirect to when requested like http://ip.ad.dr.es/.
Lang
- add - Add a new language.
- changeCurrentUserLanguage - Change the current language.
- delete - Delete a language file.
- listLanguages - List languages available for use in interworx.
- syncLanguage - Trigger language synchronization for a node.
Logout
- logout - Logout of NodeWorx.
Logs
- view - View system logs.
MailImap
- isRunning - Checks if the service is running or not.
- isRunningOnNode - Checks if the service is running on a specific node (Clustering only).
- listGeneralName - Lists the "normal" name - ie "web server" instead of "httpd".
- listPortNumbers - Lists a string of the port numbers that this service uses, comma-seperated.
- listPortNumbersArray - Lists array of port numbers and ranges that this service uses.
- listRequiredPermissions - Lists an array of permissions required to control the service.
- listServiceInfo - Lists the service name, ports, page, and status.
- listServiceName - Lists the service name - ie "httpd" instead of "web server".
- listServicePage - Lists the page that controls the service.
- restart - Restarts the service.
- restartOnNode - Restarts the service on a specific node (Clustering only).
- start - Starts the service.
- startOnBoot - Action function that handles imap4 start-on-boot status changing.
- startOnNode - Starts the service on a specific node (Clustering only).
- stop - Stops the service.
- stopOnNode - Stops the service on a specific node (Clustering only).
- update - Update IMAP4 server settings.
MailMda
- ~~startOnBootIMAP4~~ - Use Ctrl_Nodeworx_MailImap::startOnBoot DEPRECATED in version 4.2.0-260
- ~~startOnBootPop3~~ - Use Ctrl_Nodeworx_MailPop3::startOnBoot DEPRECATED in version 4.2.0-260
- ~~startOnBootSIMAP4~~ - Use Ctrl_Nodeworx_MailSImap::startOnBoot DEPRECATED in version 4.2.0-260
- ~~startOnBootSPOP3~~ - Use Ctrl_Nodeworx_MailSpop3::startOnBoot DEPRECATED in version 4.2.0-260
- ~~updateImap~~ - Use Ctrl_Nodeworx_MailImap::update DEPRECATED in version 4.2.0-260
- ~~updatePop3~~ - Use Ctrl_Nodeworx_MailPop3::update DEPRECATED in version 4.2.0-260
MailMta
- disableLocalDelivery - Bulk Disable local mail delivery for domains on the system.
- enableLocalDelivery - Bulk Enable local mail delivery for domains on the system.
- updateBounce - Update the mail server "bounce" settings.
- updateGeneral - Update mail server default-domain and hostname.
- ~~updateInbound~~ - Use Ctrl_Nodeworx_MailSmtp::updateInbound DEPRECATED in version 4.2.0-260
- ~~updateOutbound~~ - Use Ctrl_Nodeworx_MailSend::update DEPRECATED in version 4.2.0-260
- updateRrd - Show or hide the mail server RRD graph in the web interface.
MailPop3
- isRunning - Checks if the service is running or not.
- isRunningOnNode - Checks if the service is running on a specific node (Clustering only).
- listGeneralName - Lists the "normal" name - ie "web server" instead of "httpd".
- listPortNumbers - Lists a string of the port numbers that this service uses, comma-seperated.
- listPortNumbersArray - Lists array of port numbers and ranges that this service uses.
- listRequiredPermissions - Lists an array of permissions required to control the service.
- listServiceInfo - Lists the service name, ports, page, and status.
- listServiceName - Lists the service name - ie "httpd" instead of "web server".
- listServicePage - Lists the page that controls the service.
- restart - Restarts the service.
- restartOnNode - Restarts the service on a specific node (Clustering only).
- start - Starts the service.
- startOnBoot - Set pop3 start-on-boot status.
- startOnNode - Starts the service on a specific node (Clustering only).
- stop - Stops the service.
- stopOnNode - Stops the service on a specific node (Clustering only).
- update - Update POP3 server settings.
MailQueue
- delete - Delete messages from the queue.
- expire - Expire messages in the queue.
- listStats - Lists information about current queue statistics.
- process - Sends the ALRM signal to qmail, which tells it to process the mail queue.
- purge - Purge mail queue.
- queryQueue - Lists the contents of the selected queue.
- sendTestMessage - Send a test message to see if the mail delivery is working.
- unexpire - Unexpire messages in the queue.
MailSend
- isRunning - Checks if the service is running or not.
- isRunningOnNode - Checks if the service is running on a specific node (Clustering only).
- listGeneralName - Lists the "normal" name - ie "web server" instead of "httpd".
- listPortNumbers - Lists a string of the port numbers that this service uses, comma-seperated.
- listPortNumbersArray - Lists array of port numbers and ranges that this service uses.
- listRequiredPermissions - Lists an array of permissions required to control the service.
- listServiceInfo - Lists the service name, ports, page, and status.
- listServiceName - Lists the service name - ie "httpd" instead of "web server".
- listServicePage - Lists the page that controls the service.
- restart - Restarts the service.
- restartOnNode - Restarts the service on a specific node (Clustering only).
- start - Starts the service.
- startOnNode - Starts the service on a specific node (Clustering only).
- stop - Stops the service.
- stopOnNode - Stops the service on a specific node (Clustering only).
- update - Update misc outbound mail server settings.
MailSimap
- isRunning - Checks if the service is running or not.
- isRunningOnNode - Checks if the service is running on a specific node (Clustering only).
- listGeneralName - Lists the "normal" name - ie "web server" instead of "httpd".
- listPortNumbers - Lists a string of the port numbers that this service uses, comma-seperated.
- listPortNumbersArray - Lists array of port numbers and ranges that this service uses.
- listRequiredPermissions - Lists an array of permissions required to control the service.
- listServiceInfo - Lists the service name, ports, page, and status.
- listServiceName - Lists the service name - ie "httpd" instead of "web server".
- listServicePage - Lists the page that controls the service.
- restart - Restarts the service.
- restartOnNode - Restarts the service on a specific node (Clustering only).
- start - Starts the service.
- startOnBoot - Set secure imap4 start-on-boot status.
- startOnNode - Starts the service on a specific node (Clustering only).
- stop - Stops the service.
- stopOnNode - Stops the service on a specific node (Clustering only).
MailSmtp
- isRunning - Checks if the service is running or not.
- isRunningOnNode - Checks if the service is running on a specific node (Clustering only).
- listGeneralName - Lists the "normal" name - ie "web server" instead of "httpd".
- listPortNumbers - Lists a string of the port numbers that this service uses, comma-seperated.
- listPortNumbersArray - Lists array of port numbers and ranges that this service uses.
- listRequiredPermissions - Lists an array of permissions required to control the service.
- listServiceInfo - Lists the service name, ports, page, and status.
- listServiceName - Lists the service name - ie "httpd" instead of "web server".
- listServicePage - Lists the page that controls the service.
- restart - Restarts the service.
- restartOnNode - Restarts the service on a specific node (Clustering only).
- start - Starts the service.
- startOnNode - Starts the service on a specific node (Clustering only).
- stop - Stops the service.
- stopOnNode - Stops the service on a specific node (Clustering only).
- update - Change the auth settings for the primary SMTP server.
- updateInbound - Update misc inbound mail server settings.
MailSmtp2
- isRunning - Checks if the service is running or not.
- isRunningOnNode - Checks if the service is running on a specific node (Clustering only).
- listGeneralName - Lists the "normal" name - ie "web server" instead of "httpd".
- listPortNumbers - Lists a string of the port numbers that this service uses, comma-seperated.
- listPortNumbersArray - Lists array of port numbers and ranges that this service uses.
- listRequiredPermissions - Lists an array of permissions required to control the service.
- listServiceInfo - Lists the service name, ports, page, and status.
- listServiceName - Lists the service name - ie "httpd" instead of "web server".
- listServicePage - Lists the page that controls the service.
- restart - Restarts the service.
- restartOnNode - Restarts the service on a specific node (Clustering only).
- start - Starts the service.
- startOnNode - Starts the service on a specific node (Clustering only).
- stop - Stops the service.
- stopOnNode - Stops the service on a specific node (Clustering only).
- update - Change the auth settings for the alternate port SMTP server.
MailSpam
- addAdvanced - Displays the add advanced form.
- autoRestart - Set the spamassassin auto-restart status.
- deleteAdvanced - Delete advanced spamassassin configuration.
- editAdvanced - Edit advanced spamassassin configuration.
- isRunning - Checks if the service is running or not.
- isRunningOnNode - Checks if the service is running on a specific node (Clustering only).
- listGeneralName - Lists the "normal" name - ie "web server" instead of "httpd".
- listPortNumbers - Lists a string of the port numbers that this service uses, comma-seperated.
- listPortNumbersArray - Lists array of port numbers and ranges that this service uses.
- listPreferences - Lists information about current spam preferences.
- listRequiredPermissions - Lists an array of permissions required to control the service.
- listServiceInfo - Lists the service name, ports, page, and status.
- listServiceName - Lists the service name - ie "httpd" instead of "web server".
- listServicePage - Lists the page that controls the service.
- restart - Restarts the service.
- restartOnNode - Restarts the service on a specific node (Clustering only).
- start - Starts the service.
- startonboot - Set the spamassassin start-on-boot status.
- startOnNode - Starts the service on a specific node (Clustering only).
- stop - Stops the service.
- stopOnNode - Stops the service on a specific node (Clustering only).
- updateBayes - Update spamassassin bayes configuration.
- updateLists - Update spamassassin global white and black lists.
- updateOptions - Update spamassassin options.
MailSpop3
- isRunning - Checks if the service is running or not.
- isRunningOnNode - Checks if the service is running on a specific node (Clustering only).
- listGeneralName - Lists the "normal" name - ie "web server" instead of "httpd".
- listPortNumbers - Lists a string of the port numbers that this service uses, comma-seperated.
- listPortNumbersArray - Lists array of port numbers and ranges that this service uses.
- listRequiredPermissions - Lists an array of permissions required to control the service.
- listServiceInfo - Lists the service name, ports, page, and status.
- listServiceName - Lists the service name - ie "httpd" instead of "web server".
- listServicePage - Lists the page that controls the service.
- restart - Restarts the service.
- restartOnNode - Restarts the service on a specific node (Clustering only).
- start - Starts the service.
- startOnBoot - Set secure pop3 start-on-boot status.
- startOnNode - Starts the service on a specific node (Clustering only).
- stop - Stops the service.
- stopOnNode - Stops the service on a specific node (Clustering only).
MailVirus
- autoRestart - Set the clamav autorestart status.
- isRunning - Checks if the service is running or not.
- isRunningOnNode - Checks if the service is running on a specific node (Clustering only).
- listGeneralName - Lists the "normal" name - ie "web server" instead of "httpd".
- listPortNumbers - Lists a string of the port numbers that this service uses, comma-seperated.
- listPortNumbersArray - Lists array of port numbers and ranges that this service uses.
- listRequiredPermissions - Lists an array of permissions required to control the service.
- listServiceInfo - Lists the service name, ports, page, and status.
- listServiceName - Lists the service name - ie "httpd" instead of "web server".
- listServicePage - Lists the page that controls the service.
- options - Update clamav options.
- restart - Restarts the service.
- restartOnNode - Restarts the service on a specific node (Clustering only).
- start - Starts the service.
- startOnBoot - Set the clamav start-on-boot status.
- startOnNode - Starts the service on a specific node (Clustering only).
- stop - Stops the service.
- stopOnNode - Stops the service on a specific node (Clustering only).
Mysql
- ~~add~~ - 2011-03-30 Use Ctrl_Nodeworx_MysqlRemote::add DEPRECATED in version 4.8.0-393
- autoRestart - Set the mysql server auto-restart status.
- ~~default~~ - 2011-03-30 Use Ctrl_Nodeworx_MysqlRemote::default DEPRECATED in version 4.8.0-393
- isRunning - Checks if the service is running or not.
- isRunningOnNode - Checks if the service is running on a specific node (Clustering only).
- ~~list~~ - 2011-03-30 Use Ctrl_Nodeworx_MysqlRemote::listServers DEPRECATED in version 4.8.0-393
- ~~listActiveServers~~ - 2011-03-30 Use Ctrl_Nodeworx_MysqlRemote::listActiveServers DEPRECATED in version 4.8.0-393
- ~~listDeletableServers~~ - 2011-03-30 Use Ctrl_Nodeworx_MysqlRemote::listDeletableServers DEPRECATED in version 4.8.0-393
- listGeneralName - Lists the "normal" name - ie "web server" instead of "httpd".
- ~~listInactiveServers~~ - 2011-03-30 Use Ctrl_Nodeworx_MysqlRemote::listInactiveServers DEPRECATED in version 4.8.0-393
- listPortNumbers - Lists a string of the port numbers that this service uses, comma-seperated.
- listPortNumbersArray - Lists array of port numbers and ranges that this service uses.
- listRequiredPermissions - Lists an array of permissions required to control the service.
- listServiceInfo - Lists the service name, ports, page, and status.
- listServiceName - Lists the service name - ie "httpd" instead of "web server".
- listServicePage - Lists the page that controls the service.
- ~~nickname~~ - 2011-03-30 Use Ctrl_Nodeworx_MysqlRemote::nickname DEPRECATED in version 4.8.0-393
- options - Configure various mysql service options.
- queryProcesses - Query processes on the local mysql server.
- restart - Restarts the service.
- restartOnNode - Restarts the service on a specific node (Clustering only).
- rootpass - Change the given MySQL Server's root password.
- rrdGraph - Set the mysql server connections RRD graph display status.
- start - Starts the service.
- startOnBoot - Set the mysql server start-on-boot-status.
- startOnNode - Starts the service on a specific node (Clustering only).
- stop - Stops the service.
- stopOnNode - Stops the service on a specific node (Clustering only).
MysqlRemote
- activate - Reactivate a mysql server if it has gone offline.
- add - Add a new mysql server to the pool.
- default - Sets the default mysql server to use for new SiteWorx accounts and resellers.
- listActiveServers - List active MySQL servers.
- listDeletableServers - List deletable MySQL servers.
- listInactiveServers - List inactive MySQL servers.
- listServers - Lists the available mysql servers.
- nickname - Change a mysql server's nickname.
- rootpass - Change the given MySQL Server's root password.
Nfs
- isRunning - Checks if the service is running or not.
- isRunningOnNode - Checks if the service is running on a specific node (Clustering only).
- listGeneralName - Lists the "normal" name - ie "web server" instead of "httpd".
- listPortNumbers - Lists a string of the port numbers that this service uses, comma-seperated.
- listPortNumbersArray - Lists array of port numbers and ranges that this service uses.
- listRequiredPermissions - Lists an array of permissions required to control the service.
- listServiceInfo - Lists the service name, ports, page, and status.
- listServiceName - Lists the service name - ie "httpd" instead of "web server".
- listServicePage - Lists the page that controls the service.
- restart - Restarts the service.
- restartOnNode - Restarts the service on a specific node (Clustering only).
- start - Starts the service.
- startOnBoot - Set the NFS start-on-boot status.
- startOnNode - Starts the service on a specific node (Clustering only).
- stop - Stops the service.
- stopOnNode - Stops the service on a specific node (Clustering only).
NfsExport
- add - Add a NFS Export.
- listNfsExports - List NFS Exports.
NfsMount
- add - Add a NFS mount.
- listNfsMounts - List Nfs mounts.
Notice
- dismissBanner - Dismisses a banner notice.
- ignoreUntil - Ignore a notice until a certain time.
- listBannerNotices - Lists current banner notices.
- removeUnsubscription - Removes an unsubscription block for the current user.
- unsubscribe - Unsubscribes the current user from a problem code.
Overview
- editProfile - Edit the currently authenticated users' profile.
- listHostname - List the hostname of the system.
- listLicenseKey - List the interworx license key.
- listLoadAverage - Lists the one, five, and fifteen-minute load averages.
- listServiceStatus - Lists the status and port numbers of InterWorx-managed services.
- listVersion - List the version of InterWorx installed.
Packages
- add - Add a siteworx package.
- backup - Backup a siteworx package.
- delete - Delete a siteworx package.
- edit - Edit a siteworx package.
- import - Import a siteworx package.
- listDetails - Lists SiteWorx package details.
- ~~listIds~~ - 2011-01-18 Use listPackages instead DEPRECATED in version 4.8.0-393
- listPackages - List SiteWorx Packages.
Plugins
- edit - Edit a plugin.
- listPlugins - Get list of plugins.
Reseller
- add - Add a new reseller account.
- delete - Delete a reseller account.
- edit - Edit a reseller account.
- listDeletableIds - List deletable reseller accounts by id.
- listEditableIds - List editable reseller accounts by id.
- ~~listIds~~ - 2011-01-24 use listResellersAction DEPRECATED in version 4.8.0-393
- listResellers - List all resellers.
- queryResellerBandwidth - Query Reseller Account bandwidth usage data for any billing period.
- queryResellerDetails - Query reseller account details.
ResellerBandwidthhistory
- listBandwidth - List the bandwidth history overview.
- queryBandwidth - Search for bandwidth history for a given reseller.
- queryBandwidthDetails - Search for reseller bandwidth details for a given period.
ResellerPackages
- add - Add a Reseller Package.
- backup - Backup a reseller package.
- delete - Delete a reseller package.
- edit - Edit an existing Reseller Package.
- import - Import a reseller package.
- listDetails - Lists Reseller package details.
- ~~listIds~~ - 2011-01-25 Use listResellerPackages instead. DEPRECATED in version 4.8.0-393
- listResellerPackages - List reseller packages.
Settings
- edit - Edit misc interworx settings.
Shell
- changeshell - Change the user's shell.
- disable - Disable the specified shell user.
- enable - Enable the specified shell user.
- listSiteworxUsers - Lists the SiteWorx shell users.
- listSystemUsers - Lists the System shell users.
- password - Change a shell user password.
- shellOptions - Change the default shell.
Simplescripts
- editConfig - Edit the simple scripts configuration.
Siteworx
- add - Add a SiteWorx account.
- ~~bulkactivate~~ - 2011-01-20 Use unsuspend instead. DEPRECATED in version 4.8.0-393
- ~~bulkdeactivate~~ - 2011-01-20 Use suspend instead. DEPRECATED in version 4.8.0-393
- ~~bulkdelete~~ - 2011-01-20 Use delete instead. DEPRECATED in version 4.8.0-393
- delete - Delete a SiteWorx Account.
- edit - Edit a SiteWorx account.
- listAccounts - List Siteworx accounts summary.
- listBandwidthAndStorage - Lists bandwidth and storage usage for the current billing period.
- listCurrentDomainBandwidthData - List bw data for all master and secondary domains for the active biling period.
- listDedicatedFreeIps - List available dedicated ip addresses.
- listFreeIps - List available ip addresses.
- listMasterDomains - List master domains.
- listSharedFreeIps - List available shared ip addresses.
- ~~listSiteworxAccounts~~ - 2011-01-21 Use listAccounts. DEPRECATED in version 4.8.0-393
- queryAccountBandwidth - Query Siteworx Account bandwidth usage data for any billing period.
- queryDomainInfo - Get info about a domain on the system. Can be used to see if a domain exists.
- querySiteworxAccountDetails - Get all SiteWorx account properties of a given domain.
- querySiteworxAccounts - Query Siteworx accounts by specifying which properties you want returned.
- search - Search siteworx accounts summary.
- siteworxLogin - Login to a given SiteWorx account.
- suspend - Suspend a SiteWorx account.
- suspendByUser - Suspend a SiteWorx account by unix user name.
- syncServerAlias - Synchronize server aliases with InterWorx database.
- syncVirtualHosts - Synchronize InterWorx and Apache vitrual host blocks.
- toggleFavorite - Toggle a "favorite" SiteWorx account.
- unsuspend - Unsuspend a SiteWorx account.
- unsuspendByUser - Unsuspend a SiteWorx account by unix user name.
Sshd
- autoRestart - Configure SSHD auto-restart.
- isRunning - Checks if the service is running or not.
- isRunningOnNode - Checks if the service is running on a specific node (Clustering only).
- listGeneralName - Lists the "normal" name - ie "web server" instead of "httpd".
- listPortNumbers - Lists a string of the port numbers that this service uses, comma-seperated.
- listPortNumbersArray - Lists array of port numbers and ranges that this service uses.
- listRequiredPermissions - Lists an array of permissions required to control the service.
- listServiceInfo - Lists the service name, ports, page, and status.
- listServiceName - Lists the service name - ie "httpd" instead of "web server".
- listServicePage - Lists the page that controls the service.
- listSessions - Lists information about current shell sessions.
- restart - Restarts the service.
- restartOnNode - Restarts the service on a specific node (Clustering only).
- start - Starts the service.
- startOnBoot - Configure SSHD start-on-boot.
- startOnNode - Starts the service on a specific node (Clustering only).
- stop - Stops the service.
- stopOnNode - Stops the service on a specific node (Clustering only).
- terminate - Terminate shell sessions.
- updateConfig - Configure SSHD server settings.
- updateRrd - Toggle SSHD rrd graph in web interface.
Ssl
- edit - Edit an ssl certificate.
- generate - Generate a self-signed SSL cert.
- listSslCerts - List installed server SSL Certificates.
- updateall - Update all services to use the same SSL cert.
- view - View a given ssl cert, and any related information.
Themes
- add - Add a new theme.
- delete - Delete a theme.
- list - List installed themes.
- listDeletable - List deletable themes.
- switchAllUsersTheme - Switch users from one theme to another.
- syncTheme - Sychronizes a theme to the cluster nodes.
- update - Upgrade a theme.
Updates
- apply - Apply available updates for specified packages.
- listAvailableUpdates - Lists available updates.
- listRecentUpdates - Lists recent updates.
- options - Set auto-update options.
- queryHistory - Lists history for a specific package.
Users
- activate - Activates a NodeWorx user.
- add - Add a new nodeworx user.
- deactivate - Deactivates (but does not delete) a NodeWorx user.
- delete - Delete a nodeworx user.
- edit - Edit a user.
- isReseller - Check if the current user is a reseller or not.
- ~~list~~ - 2011-01-24 use listUsersAction DEPRECATED in version 4.8.0-393
- listDeletable - List deletable NodeWorx users.
- listEditable - List editable NodeWorx users.
- listMasterUser - Get details of the master user.
- listUsers - List NodeWorx users.
- listWorkingUser - Get details of the working user.

SiteWorx API

Backup
- create - Create a SiteWorx backup.
- delete - Delete a siteworx backup.
- ~~deleteCron~~ - 2010-11-30 use /siteworx/backup/schedule action=delete DEPRECATED in version 4.8.0-393
- listAllBackups - List all backups created manually.
- listDailyBackups - List all current daily backups.
- listMonthlyBackups - List all current monthly backups.
- listWeeklyBackups - List all current weekly backups.
- restore - Restore a partial siteworx backup.
- ~~schedule~~ - 2010-11-30 use /siteworx/backup/schedule action=create DEPRECATED in version 4.8.0-393
BackupSchedule
- create - Add a scheduled backup.
- listScheduled - Lists all the scheduled backups for the current SiteWorx user.
Cron
- add - Add a new cronjob to the user's crontab.
- delete - Delete cronjobs from the SiteWorx user's crontab.
- edit - Edit an existing cronjob in the user's crontab.
- list - List cron jobs.
- options - Edit cron options.
Dns
- ~~add~~ - 2011-04-05 Use individual add[ type ] functions instead. DEPRECATED in version 4.8.0-393
- addA - Add an A record.
- addAAAA - Add an AAAA record.
- addCNAME - Add a CNAME record.
- addMX - Add an MX record.
- addSPF - Add an SPF record.
- addTXT - Add a TXT record.
- delete - Delete a DNS Record.
- editA - Edit an A record.
- editAAAA - Edit an AAAA record.
- editCNAME - Edit a CNAME record.
- editMX - Edit an MX record.
- editSPF - Edit an SPF record.
- editTXT - Edit a TXT record.
- queryDnsRecords - List DNS Records that are part of the zone.
DomainsPointer
- add - Add a pointer domain.
- addMailPointerDomain - Add a pointer domain for mail.
- delete - Delete a pointer domain.
- deleteMailPointer - Delete a pointer domain for mail.
- ~~list~~ - 2010-11-18 use listPointerDomains. DEPRECATED in version 4.8.0-393
- listPointerDomains - List pointer domains.
DomainsSlave
- add - Add a secondary domain.
- delete - Delete a secondary domain.
- ~~list~~ - 2010-11-18 use listSecondaryDomains DEPRECATED in version 4.8.0-393
- ~~listIds~~ - 2010-11-18 no longer servers any real purpose, will be removed. DEPRECATED in version 4.8.0-393
- listSecondaryDomains - List master domain and secondary domains.
DomainsSub
- add - Add a subdomain.
- delete - Delete a subdomain.
- ~~list~~ - 2010-11-18 use listSubdomains instead. DEPRECATED in version 4.8.0-393
- listSubdomains - List subdomains.
Email
- editBounce - Edit bounce action.
EmailAlias
- add - Add an e-mail alias.
- delete - Delete an e-mail alias.
- edit - Edit an e-mail alias.
- ~~list~~ - 2010-11-18 use listEmailAliases DEPRECATED in version 4.8.0-393
- listEmailAliases - List e-mail aliases.
EmailAutorespond
- add - Add an e-mail autoresponder.
- delete - Delete an e-mail autoresponder.
- edit - Edit an e-mail autoresponder.
- ~~list~~ - 2010-11-18 use listEmailAutoresponders DEPRECATED in version 4.8.0-393
- listEmailAutoresponders - List e-mail autoresponders.
EmailBox
- add - Add an e-mail box.
- delete - Delete an e-mail box.
- edit - Edit an e-mail box.
- ~~list~~ - 2010-11-18 use listEmailBoxes DEPRECATED in version 4.8.0-393
- listEmailBoxes - List e-mail boxes (pop/imap).
EmailDomainkeys
- add - Add DomainKeys configuration.
- delete - Delete DomainKeys configuration.
- edit - Edit DomainKeys configuration.
- listDomainkeyDomains - List DomainKeys compatible domains.
- listDomainKeys - Lists the domain keys.
- queryDomainKeys - List the domain key DNS records for a given domain.
- view - View a set of domainkeys for a given domain.
EmailFilters
- add - Add an e-mail filter.
- addFrom - Add a "from" e-mail filter.
- addSubject - Add a "subject" e-mail filter.
- delete - Delete e-mail filters.
- filterBehavior - Set the filtered e-mail behavior.
- listFilters - Lists information about SW mail filters.
EmailGroup
- add - Add an e-mail group.
- delete - Delete an e-mail group.
- edit - Edit an e-mail group.
- ~~list~~ - 2010-11-18 use listEmailGroups DEPRECATED in version 4.8.0-393
- listEmailGroups - List e-mail groups.
EmailRemotesetup
- addmx - Add an MX record.
- deletemx - Delete an MX record.
- disableLocalDelivery - Disables local delivery for specified domains.
- editmx - Edit an MX record.
- enableLocalDelivery - Enables local delivery for specified domains.
- listLocalDeliveryStatus - Lists the status of local delivery for domains.
- listMxRecordIds - List domain MX records by id.
- listMxRecords - List MX Records for the SiteWorx account.
- localDelivery - Change whether this box accepts email locally for a domain.
EmailSpamprefs
- addAdvanced - Add advanced spamassassin configuration options.
- deleteAdvanced - Delete advanced spamassassin configuration options.
- edit - Edit spamassassin configuration settings.
- editAdvanced - Edit advanced spamassassin configuration options.
- listGlobalPreferences - Lists information about global spam preferences.
- listPreferences - Lists information about current spam preferences.
- listSpamPreferenceIds - List e-mail spam preferences by id.
EmailSpf
- delete - Delete a domain SPF configuration.
- edit - Edit a single domain SPF configuration.
- editAll - Edit all domains SPF configuration.
- ~~listSpfDomains~~ - Use listSpfRecords instead. DEPRECATED in version 4.8.0-393
- listSpfRecords - Lists the SPF records.
Ftp
- add - Add an FTP account.
- edit - Edit a FTP account.
- ~~list~~ - 2010-11-18 use listFtpAccounts DEPRECATED in version 4.8.0-393
- listDeletable - List deletable FTP accounts.
- listFtpAccounts - List FTP Accounts.
FtpSessions
- kill - Kill ftp sessions.
- listFtpSessions - List Ftp Sessions.
Gems
- cleanup - Cleanup a gem, uninstalling all versions but the latest.
- install - Install a gem.
- installversion - InstallCommitAction.
- reinstall - Reinstall a gem.
- uninstall - Uninstall a gem.
- update - Update a gem.
Index
- getSession - Gets the session id.
Logout
- logout - Logout of SiteWorx.
MysqlDb
- add - Add a mysql database.
- delete - Delete a mysql database.
- ~~list~~ - 2010-12-03 use listDatabases DEPRECATED in version 4.8.0-393
- listMysqlDatabases - List MySQL Databases.
- listMysqlHost - List the mysql host for this account (localhost, 22.33.44.55, etc).
MysqlPerms
- add - Add mysql permissions.
- edit - Edit mysql permissions.
- listAvailablePerms - List available MySQL permissions.
- queryDatabaseUserPerms - Given a database, find all the db users and their permissions on that db.
MysqlUser
- add - Add a mysql user.
- delete - Delete a mysql user.
- edit - Edit a mysql user.
- ~~list~~ - 2010-12-03 use listMysqlUsers DEPRECATED in version 4.8.0-393
- listMysqlUsers - List MySQL users.
Notice
- dismissBanner - Dismisses a banner notice.
- ignoreUntil - Ignore a notice until a certain time.
- listBannerNotices - Lists current banner notices.
- removeUnsubscription - Removes an unsubscription block for the current user.
- unsubscribe - Unsubscribes the current user from a problem code.
Overview
- editProfile - Edit the currently authenticated users' profile.
- listAccountDetails - List siteworx account details.
- listAvailableDiskSpace - List available disk space action.
- listLicenseKey - List the InterWorx license key.
- listMasterDomain - List the current master domain.
- listPhpInstallMode - Get the mode php is running under.
- listVersion - List the version of InterWorx installed.
- listWorkingDomain - List the current working domain.
- queryLegacyScriptworxInstallations - Query legacy scriptworx installations.
Rails
- create - Create a new Rails application.
- delete - Delete a Rails application.
- displayLog - Display Rails logs.
- edit - Edit a Rails application.
- rake - Execute a Rake command on an application.
- restart - Restart a Rails application.
Users
- activate - Activates a SiteWorx user.
- add - Add a siteworx user.
- deactivate - Deactivates (but does not delete) a SiteWorx user.
- delete - Delete a siteworx user.
- edit - Edit a siteworx user.
- ~~list~~ - 2011-01-27 use ListUsersAction DEPRECATED in version 4.8.0-393
- listDeletable - List deletable SiteWorx users.
- listEditable - List editable SiteWorx users.
- listMasterUser - Get details of the working user.
- listUsers - List SiteWorx users.
- listWorkingUser - Get details of the working user.

API Table of Contents

NodeWorx API

SiteWorx API

Search

What's New

About InterWorx

Documentation

Support

Developer

Partners

Integrates With