InterWorx API[A][A]Last Updated: Thursday, December 13, 2012 for InterWorx Version 4.11.1-458

by InterWorx LLC

Table of Contents

Part I. InterWorx API Overview

1 Introduction

The InterWorx API is a fantastic resource for developers to easily and rapidly achieve integration of InterWorx into their own products. The InterWorx API also allows the technically savvy webhost to automate custom tasks that might otherwise be too difficult or cumbersome to perform manually. It allows complete and total control over almost every aspect that a user would have access to if they were performing the actions themselves through the web interface. It is capable of feeding the same information that a user would see inside the control panel to your own application. The main reason that the API is so robust is that the NodeWorx and SiteWorx web interfaces are API clients themselves - InterWorx operates as an abstracted application model behind the API. That means all new features are added to the API first before they are even accessible in the web interface and that means you will rarely have to wait for something that you can do in the interface to become available in the API.
The API is based on open standards known collectively as “Web Services,” which include XMLRPC, SOAP, and the Web Services Definition Language (WSDL). These standards are supported by a wide range of development tools on a variety of platforms. Since the API requests and responses in the InterWorx API follow current standards, any programming language with the appropriate library support can be used.
SOAP WSDL Point of Contact
https://%%SERVERNAME%%:2443/soap?wsdl
XMLRPC Point of Contact
https://%%SERVERNAME%%:2443/xmlrpc
where %%SERVERNAME%% is the IP or Hostname of the InterWorx server.

The Two API’s

The API is divided into 2 parts just like panel. There is the NodeWorx API which allows you to perform server administration tasks and manage resellers or SiteWorx accounts just like you would in NodeWorx and there’s also a SiteWorx API which pertains to a specific SiteWorx acccount and allows you to perform tasks related to that SiteWorx account. For example to edit a SiteWorx account’s usage quota you’d use the NodeWorx API but to add a new e-mail account you’d use the SiteWorx API.

Authentication

There are three ways to authenticate with the API. The easiest way is to use the e-mail and password of a NodeWorx user and you will be able to perform the actions that the user is permitted to make. You can also use the reseller’s NodeWorx API key. The reseller system is explained in more detail in the Reseller System Guide. This is often preferred because often users lose or change their passwords which would break integration. The API key, on the other hand, will only change if perhaps it is compromised or the NodeWorx reseller wants to discontinue allowing access to a 3rd party application. Lastly, you can use the session ID which might be preferable in instances where the user clicks a button in a plugin and their session ID is passed to your application to provide temporary access to their panel’s functions.
The one thing to remember, though, is when using the SiteWorx API, you must specify a domain to work on or the API won’t know which SiteWorx account you are referring to.

2 Using the API

2.1 PHP Example Usage

The first thing we need to worry about is creating our authentication array object. As stated in the overview, we have 3 options: Username and Password combo, API key, and session ID.

2.1.1 Authenticating via Username and Password

For the username and password, we just need create an associative array with email and password as keys for a NodeWorx API login.
$key = array( ’email’	=> ’nodeworxlogin@example.com’,
              ’password’ => ’nodeworxpass’);
Alternatively if we are authenticating with the SiteWorx API, we will need to specify a domain.
$key = array( ’email’    => ’siteworx@siteworx.com’,
              ’password’ => ’siteworxpass’,
              ’domain’   => ’example.com’ );
This is one of the more basic ways to log in. The caveat is that if the user’s password is changed, your code will stop being able to authenticate with the API.

2.1.2 Authenticating via an API key

Each reseller account can create an API key as well, and use that to login, rather than use the e-mail/password combination.
<?php
// NodeWorx
$key =
’—--BEGIN INTERWORX API KEY—--
...
—--END INTERWORX API KEY—--’;              
​
// SiteWorx
$key = 
  array( ’domain’ => %%YOURDOMAIN%%,
         ’apikey’ => ’—--BEGIN INTERWORX API KEY—--.....’ );

2.1.3 Examples API call using XMLRPC and SOAP, in PHP


$key = array( 'email'    => 'nodeworxlogin@example.com',

              'password' => 'nodeworxpass' );



$api_controller = '/nodeworx/users';

$action         = 'add';



// Be aware that even actions that require no input still require the parameter

// Just pass in an empty array

$input = array( 'nickname'         => 'Example User',

                'email'            => 'exampleuser@example.com',

                'language'         => 'en-us',

                'theme'            => 'interworx',

                'password'         => 'pass',

                'confirm_password' => 'pass',

                'perms'            => array( 'LOGIN', 'SWACCOUNTS' ) );



$params = array( 'apikey'    => $key,

                 'ctrl_name' => $api_controller,

                 'action'    => $action,

                 'input'     => $input );



// You can connect using XMLRPC, like this:

// NOTE: You'll need to have included the Zend Framework to do this

$client = new Zend_XmlRpc_Client( 'https://%%SERVERNAME%%:2443/xmlrpc' );

$result = $client->call( 'iworx.route', $params );



// Or, you can use SOAP, like this:

// NOTE: if SOAP is missing, try 'yum install php-soap'

$client = new SoapClient( 'https://%%SERVERNAME%%:2443/soap?wsdl' );

$result = $client->route( $key, $api_controller, $action, $input );

2.2 Perl Example Usage

#!/usr/bin/perl -w



#You must install the RPC::XML perl module.

require RPC::XML;

require RPC::XML::Client;



# This is the connection to the XMLRPC service to communicate with the API

$cli = RPC::XML::Client->new('https://%%SERVERNAME%%:2443/xmlrpc');



#This is the API key stuct, pass authentication information here.

$apikey = RPC::XML::struct->new({

    'email' =>  RPC::XML::string->new('siteworx@siteworx.com'),

    'password' => RPC::XML::string->new('yourpassword'),

    'domain' =>RPC::XML::string->new('%%YOURDOMAIN%%')

				});



#This is the API controller

$ctrl_name = RPC::XML::string->new('/siteworx/email/alias');



#This is the API Action

$action = RPC::XML::string->new('add');



#This is how you pass the input, in a struct.

$input = RPC::XML::struct->new({

    'username' =>  RPC::XML::string->new('example'),

    'forwardsto' => RPC::XML::string->new('someone@somewhere.com')

			       });



#This generates a pointer to an RPC::XML::struct object, which contains

#  the API's output

#Be aware that even actions that require no input still require the parameter

#Just pass in an empty array

my $resp = $cli->send_request('iworx.route',

			      $apikey,

			      $ctrl_name,

			      $action,

			      $input);



#value() gives a pointer to a native PERL hash table. This will contain

#  the "status" and "payload" keys if the XMLRPC communication with the

#  API was successful. If there was a problem and you sent bad data to

#  the API, they keys will be "faultString" and "faultCode". You may

#  want to do some error checking here.

my $results = $resp->value();



#This assumes that we communicated properly with the API, and got a valid

#response from it.

#We check the key "status". If it's 0, the add alias worked out!

if ($results->{status} == 0){

    print "Success!\n";



} else {

    print "Failure!\n";

}



#This is here to print out the payload. The payload can be delivered in an

#array or as a string, depending which controller/action you are using.

if (ref($results->{payload}) eq 'ARRAY') {

    print "Payload is an array.\n";

    my @payload = @{$results->{payload}};

    foreach (@payload)

    {

	my @key = @{$_};

	print "@key" . "\n";

    }

} else {

    print "Payload is a string.\n";

    print $results->{payload};

}

Part II. NodeWorx API Spec

3 Controller: /nodeworx/apikey

Required Permissions "APIKEY"
Action: delete
Added in version 4.7.0-339
Description Delete API Key.
Action: generate
Added in version 4.7.0-339
Description Generates a new API Key.
Action: listApikey
Added in version 4.7.0-339
Description List the installed API Key.
Sample output
array (
’status’ => 0,
’payload’ => ’—--BEGIN INTERWORX API KEY—--
MXxfdz1vSjFjZnBfYUkhRVkwMl8+cEFSZS1mLGplIWp2fUZDRD88eDlET20o
qWm1zZllVa2hSVmt3TWw4K2NFRlNaUzVtTEdwbElXcDJmVVpEUkQ4OGVEbEV
LUJ+S21WUmslTXEzT1pLMGJrTy44OzQuVjBRRnFFb2RaMVM9c2pMQkhXSk9F
wWXpjcEpYTkVMVVF6TURWZk1ETm9SRkJrVWswOUsyMTlSU3M2VERKMVpFNHN
V2RRK1k+WGVVOiNwdWxkdz1bJiwqU3o1Olk4XlEkYmFKLiZzdzojbjRjLUhs
WT2lOd2RXeGtkQzFiSml3cVUzbzVPbGs0WGxFa1ltRktMaVp6ZHpvamJqUmp
hGeXJFbzpWY4kFWPpnRTV2a012YrV0VhJGdstUUxonWwlTMQpEdINGMJdkWw
GSkdNbEpUbERWRk11TFRsTmJVNWJlbk16ZDNKclRFc3BXMHBBS1dZM1AxVkh
N110NEcwQ0plK2o+IXBzaThKfVNtMm1eQlh+NEJNPiludT9SK3R0ITZqVjM9
sSzJvK0lYQnphVGhLZlZOdE1tMWVRbGgrTkVKTlBpbHVkVDlTSzNSMElUWnF
REFYMi17Vz0qVWE1VzVNe3V9JSgqWD48Y11eWz9zZW48UndSKj9RUlhoeSNr
xVldFMVZ6Vk1lM1Y1SlNncVdENDhZMTVlV3o1Q1pXNDhVbmRTS2o1UlVsaG9
MXxfdz1vSjFjZnBfYUkhRVkwMl8+cEFSZS1mLGplIWp2fUZDRD88eDlET20o
hFeqtkZWhkTpxGVUh3cYJmczVlUx82VKhXWIZFR1UlTpVzMWp2bxsEeJtmYU
akZob21GXTlTTVc+czllI2F9KldzfWpjRVRNdk82JUkoZjlBZWQqam8jOiN2
UVFZjK2N6bGxJMkY1S2xkQ2ZXcGpSVlJOZGs4MkpVa29aamxzWldRcWFtOGp
SnU0cj1nNzB4eFlULHhpM0pUeGFHRHNqKzNzZzs/Xm42SHZ1e0hKUnA8d0l+
+l0d8AnUKh0e1ZHS24mX/szZzNzKqNHRHFGeUp0MphHLUlFe4BzNn1jc0UnS
ajRDTTgtUkFpZGI0cHtJP19pZz1QKltbaWEkcntkeSFzOXY8ajBlRWxhRlgu
wWkdJMGNIdEpQMTlwWnoxUUtsdGJhV0VrY210a2VTRnpPWFk4YWpzbFJXeGh
RjhxR211SmVIW1tqbmJmZXRPJkZAU2s0YStNKF1FW3NaUHUsbzoyZ1ZxWFBZ
JVzF0cWJtSm1aWFJQSmtaQVUyczBZU3ROS0YxRlczTmFVSFVzYnpveVoxWnh
IWUxQl9wbnV+WW1ZPFQ0W1Ehb18oLnNtXmErcnhkRDUlPXFve0A9V0lXOXoo
rV1c1WlBGUTBXMUVoYjE4b0xuTnRYbUVyY21oa1JEVWxQWEZ2ZTBBOVYwbFh
wWXpjcEpYTkVMVVF6TURWZk1ETm9SRkJrVWswOUsyMTlSU3M2VERKMVpFNHN
sVFhFelQxcExNR0pyVHk0NE9DUXVWakJSUm1GRmIyUmFNVk01YzJwTVFraFh
Wmx+PWpPMX4+Q09bMlFQOEtUUzcjYzc=
—--END INTERWORX API KEY—--’,
)

4 Controller: /nodeworx/backup

Required Permissions "BRESTORE"
Action: fullbackup
Added in version 4.8.0-393
Description Creates a full backup for the specified domains.
Input Parameters
Name Type Notes Required?
domains struct (string) Example Values
example.com
Yes
email string Help Entry
Check the box and enter a valid email address here to be notified by email once the backup of the selected SiteWorx accounts has completed.
No
Action: queryAccounts
Added in version 4.8.0-393
Description Query the backups based on the selected reseller.
Input Parameters
Name Type Notes Required?
reseller string Example Values
all, 1, 16
Yes
Action: queryBackups
Added in version 4.8.0-393
Description Get a list of backups given a domain.
Input Parameters
Name Type Notes Required?
domain string Example Values
example.com, secondary.com
Yes
Action: restore
Added in version 4.7.0-339
Description Restore a given backup (local).
Input Parameters
Name Type Notes Required?
domain string Example Values
example.com, secondary.com
Yes
file string Example Values
example.com-full-Oct.10.2017-04.24.52.tgz, example.com-partial-Oct.10.2017-04.25.31.tgz
Yes
confirm_action struct (integer) Example Values
1
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: structureonly
Added in version 4.8.0-393
Description Creates a structure only backup for the specified domains.
Input Parameters
Name Type Notes Required?
domains struct (string) Example Values
example.com
Yes
email string Help Entry
Check the box and enter a valid email address here to be notified by email once the backup of the selected SiteWorx accounts has completed.
No

5 Controller: /nodeworx/cluster

Required Permissions "CLUSTERING"
Action: enableIPv6LoadBalancing
Added in version 5.0.14-579
Description Enable IPv6 load-balancing.
Input Parameters
Name Type Notes Required?
ipv4s struct (string) No*
ipv6s struct (string) No*
* indicates that it’s actually required, but probably already has a valid default value
Action: externalLb
Added in version 5.1.50-1292
Description Set external load balancer mode on/off (beta).
Input Parameters
Name Type Notes Required?
external_lb integer Help Entry
InterWorx runs a LVS load balancer on the cluster manager server. This can be replaced with an external load balancer configuration, but must be configured and managed outside of InterWorx. This is required if the network environment does not support LVS load balancing. This mode is currently considered BETA software.
Example Values
1, 0
Example Default Value
0
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: listLoadBalancingIPv6Options
Added in version 5.0.14-579
Description Lists IPv6s suitable for load balancing.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’2001:db8::d:1101’,
1 => ’2001:db8::d:1102’,
),
)

6 Controller: /nodeworx/cluster/lb

Required Permissions "CLUSTERING"
Action: addService
Added in version 4.7.0-339
Description Add load balancing to a service.
Input Parameters
Name Type Notes Required?
service_port integer Example Values
80, 443, 25, 587, 110, 995, 143, 993
Yes
virtual_ip string Help Entry
A virtual IP will be shared and load-balanced among your cluster according to policies set here. Load-balancing IPv6 addresses requires Linux kernel >= 2.6.28-rc3 and ipvsadm >= 1.25. Both are provided by default in RHEL 6 and CentOS 6.
Example Values
0.0.0.0, ::, 10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101
Yes
policy string Example Values
rr, wrr, lc, wlc, lblc
Yes
persistent integer Example Values
0, 300, 1800, 3600
Example Default Value
300
Yes
weight_apidoc.interworx.com integer Example Values
0, 1
Example Default Value
1
No*
weight_node1.testing.com integer Example Values
0, 1
Example Default Value
1
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: deleteService
Added in version 4.7.0-339
Description Delete loadbalancing of a service.
Input Parameters
Name Type Notes Required?
services struct (string) Example Values
10.1.15.100:80, 10.1.15.101:80, 10.1.15.102:80, 10.1.15.103:80, 10.1.15.104:80
Yes
Action: editService
Added in version 4.7.0-339
Description Edit a clustered service.
Input Parameters
Name Type Notes Required?
service string Example Values
10.1.15.100:80, 10.1.15.101:80, 10.1.15.102:80, 10.1.15.103:80, 10.1.15.104:80
Yes
policy string Example Values
rr, wrr, lc, wlc, lblc
Example Default Value
rr
No*
persistent integer Example Values
0, 300, 1800, 3600
Example Default Value
300
No*
weight_apidoc.interworx.com integer Example Default Value
1
No*
weight_node1.testing.com integer Example Default Value
0
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: isRunning
Added in version 4.7.0-339
Description Checks if the service is running or not.
Sample output
array (
’status’ => 0,
’payload’ => true,
)
Action: isRunningOnNode
Added in version 4.7.0-339
Description Checks if the service is running on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: listCurrentLoadBalancerStatus
Added in version 4.7.0-339
Description Lists the current load balancer status.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’10.1.15.100:80’ =>
array (
’info’ =>
array (
’protocol’ => ’TCP’,
’vip’ => ’10.1.15.100’,
’port’ => ’80’,
’pport’ => ’http’,
’policy’ => ’rr’,
’ppolicy’ => ’##LG_ROUND_ROBIN##’,
’persistent’ => ’300’,
),
’realservers’ =>
array (
’10.1.1.23:80’ =>
array (
’vip’ => ’10.1.1.23’,
’port’ => ’80’,
’forward’ => ’Route’,
’weight’ => ’0’,
’active’ => ’0’,
’inactive’ => ’0’,
),
’10.1.15.200:80’ =>
array (
’vip’ => ’10.1.15.200’,
’port’ => ’80’,
’forward’ => ’Local’,
’weight’ => ’1’,
’active’ => ’0’,
’inactive’ => ’0’,
),
),
),
’10.1.15.101:80’ =>
array (
’info’ =>
array (
’protocol’ => ’TCP’,
’vip’ => ’10.1.15.101’,
’port’ => ’80’,
’pport’ => ’http’,
’policy’ => ’rr’,
’ppolicy’ => ’##LG_ROUND_ROBIN##’,
’persistent’ => ’300’,
),
’realservers’ =>
array (
’10.1.1.23:80’ =>
array (
’vip’ => ’10.1.1.23’,
’port’ => ’80’,
’forward’ => ’Route’,
’weight’ => ’0’,
’active’ => ’0’,
’inactive’ => ’0’,
),
’10.1.15.200:80’ =>
array (
’vip’ => ’10.1.15.200’,
’port’ => ’80’,
’forward’ => ’Local’,
’weight’ => ’1’,
’active’ => ’0’,
’inactive’ => ’0’,
),
),
),
’10.1.15.102:80’ =>
array (
’info’ =>
array (
’protocol’ => ’TCP’,
’vip’ => ’10.1.15.102’,
’port’ => ’80’,
’pport’ => ’http’,
’policy’ => ’rr’,
’ppolicy’ => ’##LG_ROUND_ROBIN##’,
’persistent’ => ’300’,
),
’realservers’ =>
array (
’10.1.1.23:80’ =>
array (
’vip’ => ’10.1.1.23’,
’port’ => ’80’,
’forward’ => ’Route’,
’weight’ => ’0’,
’active’ => ’0’,
’inactive’ => ’0’,
),
’10.1.15.200:80’ =>
array (
’vip’ => ’10.1.15.200’,
’port’ => ’80’,
’forward’ => ’Local’,
’weight’ => ’1’,
’active’ => ’0’,
’inactive’ => ’0’,
),
),
),
’10.1.15.103:80’ =>
array (
’info’ =>
array (
’protocol’ => ’TCP’,
’vip’ => ’10.1.15.103’,
’port’ => ’80’,
’pport’ => ’http’,
’policy’ => ’rr’,
’ppolicy’ => ’##LG_ROUND_ROBIN##’,
’persistent’ => ’300’,
),
’realservers’ =>
array (
’10.1.1.23:80’ =>
array (
’vip’ => ’10.1.1.23’,
’port’ => ’80’,
’forward’ => ’Route’,
’weight’ => ’0’,
’active’ => ’0’,
’inactive’ => ’0’,
),
’10.1.15.200:80’ =>
array (
’vip’ => ’10.1.15.200’,
’port’ => ’80’,
’forward’ => ’Local’,
’weight’ => ’1’,
’active’ => ’0’,
’inactive’ => ’0’,
),
),
),
’10.1.15.104:80’ =>
array (
’info’ =>
array (
’protocol’ => ’TCP’,
’vip’ => ’10.1.15.104’,
’port’ => ’80’,
’pport’ => ’http’,
’policy’ => ’rr’,
’ppolicy’ => ’##LG_ROUND_ROBIN##’,
’persistent’ => ’300’,
),
’realservers’ =>
array (
’10.1.1.23:80’ =>
array (
’vip’ => ’10.1.1.23’,
’port’ => ’80’,
’forward’ => ’Route’,
’weight’ => ’0’,
’active’ => ’0’,
’inactive’ => ’0’,
),
’10.1.15.200:80’ =>
array (
’vip’ => ’10.1.15.200’,
’port’ => ’80’,
’forward’ => ’Local’,
’weight’ => ’1’,
’active’ => ’0’,
’inactive’ => ’0’,
),
),
),
),
)
Action: listGeneralName
Added in version 4.7.0-339
Description Lists the "normal" name - ie "web server" instead of "httpd".
Sample output
array (
’status’ => 0,
’payload’ => ’##LG_LOAD_BALANCER##’,
)
Action: listPortNumbers
Added in version 4.7.0-339
Description Lists a string of the port numbers that this service uses, comma-seperated.
Sample output
array (
’status’ => 0,
’payload’ => ’##LG_NOT_APPLICABLE##’,
)
Action: listPortNumbersArray
Added in version 4.7.0-339
Description Lists array of port numbers and ranges that this service uses.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’##LG_NOT_APPLICABLE##’,
),
)
Action: listRequiredPermissions
Added in version 4.7.0-339
Description Lists an array of permissions required to control the service.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’CLUSTERING’,
),
)
Action: listServiceInfo
Added in version 4.7.0-339
Description Lists the service name, ports, page, and status.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’id’ => ’ipvsadm’,
’name’ => ’##LG_LOAD_BALANCER##’,
’ports’ => ’##LG_NOT_APPLICABLE##’,
’page’ => ’/nodeworx/cluster/lb’,
’ctrl’ => ’/nodeworx/cluster/lb’,
’is_running’ => 1,
),
)
Action: listServiceName
Added in version 4.7.0-339
Description Lists the service name - ie "httpd" instead of "web server".
Sample output
array (
’status’ => 0,
’payload’ => ’ipvsadm’,
)
Action: listServicePage
Added in version 4.7.0-339
Description Lists the page that controls the service.
Sample output
array (
’status’ => 0,
’payload’ => ’/nodeworx/cluster/lb’,
)
Action: queryEditService
Added in version 5.1.0-838
Description Displays the information available to the action "editService".
Input Parameters
Name Type Notes Required?
service string Example Values
10.1.15.100:80, 10.1.15.101:80, 10.1.15.102:80, 10.1.15.103:80, 10.1.15.104:80
Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’service_copy’ => ’10.1.15.100:80’,
’policy’ => ’rr’,
’persistent’ => ’300’,
’service’ => ’10.1.15.100:80’,
’port’ => ’80’,
’vip’ => ’10.1.15.100’,
’nodes’ =>
array (
’apidoc.interworx.com’ => ’1’,
’node1.testing.com’ => ’0’,
),
),
)
Action: querySettings
Added in version 5.1.0-838
Description Displays the information available to the action "settings".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’emailalert’ => ’’,
’emailalertstatus’ =>
array (
),
),
)
Action: restart
Added in version 4.7.0-339
Description Restarts the service.
Action: restartOnNode
Added in version 4.7.0-339
Description Restarts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: settings
Added in version 4.7.0-339
Description Modify ldirectord variables.
Input Parameters
Name Type Notes Required?
emailalert string Help Entry
E-mail address that will receive status changes.
No
emailalertstatus struct (string) Help Entry
Which status changes should be sent out as alerts.
Example Values
starting, running, stopping, reloading
No
Action: start
Added in version 4.7.0-339
Description Starts the service.
Action: startOnBoot
Added in version 4.7.0-339
Description Set the loadbalancer start on boot status.
Input Parameters
Name Type Notes Required?
startonboot integer Help Entry
If set to ’Yes’, the Load Balancer will be automatically started when the server starts up
Example Values
1, 0
Example Default Value
1
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: startOnNode
Added in version 4.7.0-339
Description Starts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: stop
Added in version 4.7.0-339
Description Stops the service.
Action: stopOnNode
Added in version 4.7.0-339
Description Stops the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value

7 Controller: /nodeworx/cluster/nodes

Required Permissions "CLUSTERING"
Action: add
Added in version 4.7.0-339
Description Add a cluster node.
Input Parameters
Name Type Notes Required?
hostname string Help Entry
The hostname or IP address of the node you would like to add to this cluster.
Yes
ipv4 string Yes
ipv6 string Yes
packet_forwarding_method string Help Entry
The packet forwarding method is the method of load balancing that the system will use to load balance requests to the cluster node.
Example Values
LVS-DR, LVS-TUN
Example Default Value
LVS-DR
No*
apikey string Help Entry
The InterWorx API key from the node which you would like to add. This must be retrieved from the node’s NodeWorx instance.
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: delete
Added in version 4.7.0-339
Description Delete a cluster node.
Input Parameters
Name Type Notes Required?
nodes struct (string) Example Values
node1.testing.com
Yes
confirm_action struct (integer) Example Values
1
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: forceDelete
Added in version 4.8.0-393
Description Force deletion of a cluster node, even if the cluster manager cannot reach it.
Input Parameters
Name Type Notes Required?
nodes struct (string) Example Values
node1.testing.com
Yes
confirm_action struct (integer) Example Values
1
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: listClusterNodes
Added in version 4.8.0-393
Description List cluster nodes.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’hostname’ => ’apidoc.interworx.com’,
’ipaddr’ => ’10.1.15.200’,
’ipv6’ => ’2001:db8::d:1102’,
’role’ => ’##LG_LOAD_BALANCER## / ##LG_CLUSTER_MANAGER##’,
’status’ => ’active’,
’packet_forwarding_method’ => ’LVS-DR’,
’activation_complete’ => ’yes’,
’activation_details’ => ’’,
’inprogress’ => 100,
),
1 =>
array (
’node_id’ => ’1’,
’hostname’ => ’node1.testing.com’,
’ipaddr’ => ’10.1.1.23’,
’ipv6’ => NULL,
’status’ => ’active’,
’activation_complete’ => ’yes’,
’packet_forwarding_method’ => ’LVS-DR’,
’inprogress’ => 100,
’activation_details’ => ’’,
’role’ => ’##LG_REAL_SERVER##’,
),
),
)
Action: queryHostIps
Added in version 5.0.14-579
Description Resolves IPv4 and IPv6 address of a hostname.
Input Parameters
Name Type Notes Required?
hostname string Yes

8 Controller: /nodeworx/command/queue

Required Permissions "CLUSTERING"
Action: isRunning
Added in version 4.7.0-339
Description Checks if the service is running or not.
Sample output
array (
’status’ => 0,
’payload’ => false,
)
Action: isRunningOnNode
Added in version 4.7.0-339
Description Checks if the service is running on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: listGeneralName
Added in version 4.7.0-339
Description Lists the "normal" name - ie "web server" instead of "httpd".
Sample output
array (
’status’ => 0,
’payload’ => ’##LG_COMMAND_QUEUE##’,
)
Action: listPortNumbers
Added in version 4.7.0-339
Description Lists a string of the port numbers that this service uses, comma-seperated.
Sample output
array (
’status’ => 0,
’payload’ => ’N/A’,
)
Action: listPortNumbersArray
Added in version 4.7.0-339
Description Lists array of port numbers and ranges that this service uses.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’N/A’,
),
)
Action: listRequiredPermissions
Added in version 4.7.0-339
Description Lists an array of permissions required to control the service.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’CLUSTERING’,
),
)
Action: listServiceInfo
Added in version 4.7.0-339
Description Lists the service name, ports, page, and status.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’id’ => ’iworx-queue-d’,
’name’ => ’##LG_COMMAND_QUEUE##’,
’ports’ => ’N/A’,
’page’ => ’/nodeworx/command/queue’,
’ctrl’ => ’/nodeworx/command/queue’,
’is_running’ => 0,
),
)
Action: listServiceName
Added in version 4.7.0-339
Description Lists the service name - ie "httpd" instead of "web server".
Sample output
array (
’status’ => 0,
’payload’ => ’iworx-queue-d’,
)
Action: listServicePage
Added in version 4.7.0-339
Description Lists the page that controls the service.
Sample output
array (
’status’ => 0,
’payload’ => ’/nodeworx/command/queue’,
)
Action: queryCommandHistory
Added in version 4.7.0-339
Description View history of the command queue.
Input Parameters
Name Type Notes Required?
count integer Example Default Value
20
No*
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: queryQueuedCommands
Added in version 4.7.0-339
Description Query the command queue on a node.
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: restart
Added in version 4.7.0-339
Description Restarts the service.
Action: restartOnNode
Added in version 4.7.0-339
Description Restarts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: start
Added in version 4.7.0-339
Description Starts the service.
Action: startOnNode
Added in version 4.7.0-339
Description Starts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: stop
Added in version 4.7.0-339
Description Stops the service.
Action: stopOnNode
Added in version 4.7.0-339
Description Stops the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value

9 Controller: /nodeworx/cron

Required Permissions "CRON"
Action: add
Added in version 4.7.0-339
Description Add a job to a user’s crontab.
Input Parameters
Name Type Notes Required?
interface string Example Values
simple, advanced
Example Default Value
simple
Yes
user string Example Values
axfrdns, example, iworx, nfsnobody, root
Yes
minute struct (string) Example Values
*, */2, */5, */10, */15, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, ...
Example Default Value
["*"]
No*
hour struct (string) Example Values
*, */2, */4, */6, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23
Example Default Value
["*"]
No*
day struct (string) Example Values
*, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31
Example Default Value
["*"]
No*
month struct (string) Example Values
*, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
Example Default Value
["*"]
No*
dayofweek struct (string) Example Values
*, 0, 1, 2, 3, 4, 5, 6
Example Default Value
["*"]
No*
script string Yes
* indicates that it’s actually required, but probably already has a valid default value
Action: edit
Added in version 4.7.0-339
Description Edit a cronjob on a user’s crontab.
Input Parameters
Name Type Notes Required?
enabled integer Example Values
1, 0
Example Default Value
1
No*
minute string Example Default Value
28,33,38,43,48,53,58,3,8,13,18,23
No*
hour string Example Default Value
*
No*
day string Example Default Value
*
No*
month string Example Default Value
*
No*
dayofweek string Example Default Value
*
No*
script string Example Default Value
cd /home/interworx/cron ; ./iworx.pex --fively
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: options
Added in version 4.7.0-339
Description Manage options for cron users.
Input Parameters
Name Type Notes Required?
user string Example Values
axfrdns, example, iworx, nfsnobody, root
Yes
shell string Help Entry
Use the dropdown to choose the shell to run the cron job on.
Example Values
/bin/sh, /bin/bash, /sbin/nologin, /bin/dash, /usr/sbin/jk_chrootsh
No*
path struct (string) Help Entry
The path contains the directories which will be in the search path for cron.
No
mailto string Help Entry
Enter an email address to be notified of the output of each cron job.
No
* indicates that it’s actually required, but probably already has a valid default value
Action: queryEdit
Added in version 5.1.0-838
Description Displays the information available to the action "edit".
Input Parameters
Name Type Notes Required?
job integer Example Values
2, 3, 4, 5, 6, 7, 8
Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’systemtime’ => ’Tue, 10 Oct 17 04:34:26 -0400’,
’enabled’ => ’1’,
’minute’ => ’28,33,38,43,48,53,58,3,8,13,18,23’,
’hour’ => ’*’,
’day’ => ’*’,
’month’ => ’*’,
’dayofweek’ => ’*’,
’script’ => ’cd /home/interworx/cron ; ./iworx.pex --fively’,
’user’ => ’iworx’,
’job’ => ’2’,
),
)
Action: queryJobs
Added in version 4.8.0-393
Description List user jobs.
Input Parameters
Name Type Notes Required?
user string Example Values
axfrdns, example, iworx, nfsnobody, root
Yes

10 Controller: /nodeworx/dns

Required Permissions "DNS"
Action: defaultServers
Added in version 4.7.0-339
Description Set the default nameserver (NS) records for new domains.
Input Parameters
Name Type Notes Required?
ns1 string Help Entry
The first nameserver to be used for requesting zone data for a given zone. For redundancy, a second (though equally authoritative) nameserver is required.
Example Default Value
ns1.interworx.com
No*
ns2 string Help Entry
The second nameserver to be used for requesting zone data for a given zone. An optional (equally authoritative) third nameserver can be provided for additional redundancy.
Example Default Value
ns2.interworx.com
No*
ns3 string Help Entry
Similar to the secondary nameserver, but it is only used if the primary and secondary server fail.
No
* indicates that it’s actually required, but probably already has a valid default value
Action: export
Added in version 4.10.0-440
Description Updates the DNS records from the database.
Action: flush
Added in version 4.8.0-393
Description DNS flush service action.
Input Parameters
Name Type Notes Required?
ip struct (string) Example Values
10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101, 2001:db8::d:1102, 127.0.0.1
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: install
Added in version 4.8.3-414
Description Installs a DNS server on IPs that don’t have one.
Input Parameters
Name Type Notes Required?
ip struct (string) Example Values
10.1.15.200, fe80::fcb5:65ff:fe2a:a05
No
Action: isRunning
Added in version 4.7.0-339
Description Checks if the service is running or not.
Sample output
array (
’status’ => 0,
’payload’ => true,
)
Action: isRunningOnNode
Added in version 4.7.0-339
Description Checks if the service is running on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: listDnsServices
Added in version 4.8.0-393
Description Lists information about DNS Services running.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’ip’ => ’127.0.0.1’,
’status’ => ’up’,
’type’ => ’recursive’,
),
1 =>
array (
’ip’ => ’10.1.15.100’,
’status’ => ’up’,
’type’ => ’iterative’,
),
2 =>
array (
’ip’ => ’10.1.15.101’,
’status’ => ’up’,
’type’ => ’iterative’,
),
),
)
Action: listGeneralName
Added in version 4.7.0-339
Description Lists the "normal" name - ie "web server" instead of "httpd".
Sample output
array (
’status’ => 0,
’payload’ => ’##LG_DNS_SERVER##’,
)
Action: listPortNumbers
Added in version 4.7.0-339
Description Lists a string of the port numbers that this service uses, comma-seperated.
Sample output
array (
’status’ => 0,
’payload’ => ’53’,
)
Action: listPortNumbersArray
Added in version 4.7.0-339
Description Lists array of port numbers and ranges that this service uses.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => 53,
),
)
Action: listRequiredPermissions
Added in version 4.7.0-339
Description Lists an array of permissions required to control the service.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’DNS’,
),
)
Action: listServiceInfo
Added in version 4.7.0-339
Description Lists the service name, ports, page, and status.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’id’ => ’djbdns’,
’name’ => ’##LG_DNS_SERVER##’,
’ports’ => ’53’,
’page’ => ’/nodeworx/dns’,
’ctrl’ => ’/nodeworx/dns’,
’is_running’ => 1,
),
)
Action: listServiceName
Added in version 4.7.0-339
Description Lists the service name - ie "httpd" instead of "web server".
Sample output
array (
’status’ => 0,
’payload’ => ’djbdns’,
)
Action: listServicePage
Added in version 4.7.0-339
Description Lists the page that controls the service.
Sample output
array (
’status’ => 0,
’payload’ => ’/nodeworx/dns’,
)
Action: listServiceStatus
Added in version 4.7.0-339
Description Lists information about DNS Services running.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’10.1.15.100’ =>
array (
’ip’ => ’10.1.15.100’,
’status’ => ’up’,
’mapped’ => true,
’on_system’ => true,
),
’10.1.15.101’ =>
array (
’ip’ => ’10.1.15.101’,
’status’ => ’up’,
’mapped’ => true,
’on_system’ => true,
),
’10.1.15.102’ =>
array (
’ip’ => ’10.1.15.102’,
’status’ => ’up’,
’mapped’ => true,
’on_system’ => true,
),
’10.1.15.103’ =>
array (
’ip’ => ’10.1.15.103’,
’status’ => ’up’,
’mapped’ => true,
’on_system’ => true,
),
’10.1.15.104’ =>
array (
’ip’ => ’10.1.15.104’,
’status’ => ’up’,
’mapped’ => true,
’on_system’ => true,
),
’2001:db8::d:1101’ =>
array (
’ip’ => ’2001:db8::d:1101’,
’status’ => ’up’,
’mapped’ => true,
’on_system’ => true,
),
),
)
Action: listUnmappedIps
Added in version 4.8.3-414
Description Lists information about IPs that do not have DNS running.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’ip’ => ’10.1.15.200’,
),
1 =>
array (
’ip’ => ’fe80::fcb5:65ff:fe2a:a05’,
),
),
)
Action: queryDefaultServers
Added in version 5.1.0-838
Description Displays the information available to the action "defaultServers".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’ns1’ => ’ns1.interworx.com’,
’ns2’ => ’ns2.interworx.com’,
’ns3’ => ’’,
),
)
Action: querySetSoaSerialFormat
Added in version 5.1.0-838
Description Displays the information available to the action "setSoaSerialFormat".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’mode’ => ’unix’,
’update_all_zones’ => NULL,
),
)
Action: queryZoneDefaults
Added in version 5.1.0-838
Description Displays the information available to the action "zoneDefaults".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’refresh’ => ’7200’,
’retry’ => ’300’,
’expire’ => ’1209600’,
’negative_ttl’ => ’10800’,
’enforce_rfc1912_cname’ => ’1’,
),
)
Action: remove
Added in version 4.8.0-393
Description  DNS remove service action.
Input Parameters
Name Type Notes Required?
ip struct (string) Example Values
10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101, 2001:db8::d:1102
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: restart
Added in version 4.7.0-339
Description DNS restart service action.
Input Parameters
Name Type Notes Required?
ip struct (string) Example Values
10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101, 2001:db8::d:1102, 127.0.0.1
No
Action: restartOnNode
Added in version 4.7.0-339
Description Restarts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: setSoaSerialFormat
Added in version 4.8.0-393
Description Set the DNS SOA Serial Format.
Input Parameters
Name Type Notes Required?
mode string Example Values
unix, ymd
Example Default Value
unix
No*
update_all_zones integer Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: start
Added in version 4.7.0-339
Description DNS start service action.
Input Parameters
Name Type Notes Required?
ip struct (string) Example Values
10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101, 2001:db8::d:1102, 127.0.0.1
No
Action: startOnNode
Added in version 4.7.0-339
Description Starts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: stop
Added in version 4.7.0-339
Description DNS stop service action.
Input Parameters
Name Type Notes Required?
ip struct (string) Example Values
10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101, 2001:db8::d:1102, 127.0.0.1
No
Action: stopOnNode
Added in version 4.7.0-339
Description Stops the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: zoneDefaults
Added in version 4.7.0-339
Description Update the default dns zone settings.
Input Parameters
Name Type Notes Required?
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*
enforce_rfc1912_cname integer Help Entry
RFC1912 states "A CNAME record is not allowed to coexist with any other data." In certain circumstances, you MAY want to relax this restriction if you understand the ramifications.
Example Values
1, 0
Example Default Value
1
No*
* indicates that it’s actually required, but probably already has a valid default value

11 Controller: /nodeworx/dns/record

Required Permissions "DNS"
Action: add
Added in version 4.7.0-339
Description Add a DNS record.
Warning This action has been deprecated as of version 4.8.0-393. 2011-02-23 Use the individual add(record-type) functions instead.
Input Parameters
Name Type Notes Required?
zone_id integer Yes
host string Yes
type string Example Values
A, CNAME, NS, MX, PTR, TXT, SOA, SPF, SRV, AAAA, NAPTR, CAA
Yes
target string Yes
ttl integer Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Yes
Action: addA
Added in version 4.7.0-339
Description Add an A record to a zone.
Input Parameters
Name Type Notes Required?
zone_id integer Yes
host string Example Default Value
{domain}
No*
ttl integer Description
In Seconds
Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Example Default Value
43200
No*
ipaddress string Help Entry
####
Yes
* indicates that it’s actually required, but probably already has a valid default value
Action: addAAAA
Added in version 4.8.0-393
Description Add an AAAA record to a zone.
Input Parameters
Name Type Notes Required?
zone_id integer Yes
host string Example Default Value
{domain}
No*
ttl integer Description
In Seconds
Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Example Default Value
43200
No*
ipaddress string Help Entry
####
Yes
* indicates that it’s actually required, but probably already has a valid default value
Action: addCAA
Added in version 6.0.8-1363
Description Add a CAA record to a zone.
Input Parameters
Name Type Notes Required?
zone_id integer Yes
domain string Example Default Value
{domain}
No*
ttl integer Description
In Seconds
Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Example Default Value
43200
No*
flags integer Help Entry
Issuer Critical Flag: If the "flags" value is set to ’1’, the critical flag is asserted and the property MUST be understood if the CAA record is to be correctly processed by a certificate issuer. A Certification Authority MUST NOT issue certificates for any Domain that contains a CAA critical property for an unknown or unsupported property tag that for which the issuer critical flag is set. See: RFC6844
Example Values
0, 128
Example Default Value
0
No*
tag string Help Entry
Property tags define the meaning of the CAA record. Three are currently supported, but more may be added in the future.<br/><br/><b>issue:</b>This tag is used to allow/disallow the Certificate Authority to issue certificates for the domain, including wildcard certificates.<br/><br/><b>issuewild: </b>This tag is used to allow/disallow wildcard certificates issuance for the domain.<br/><br/><b>iodef: </b>This tag specifies a method for CAs to report to the domain holder when a certificate is issued. Not all CAs support this tag, so there is no guarantee that all certificate issuances will be reported.<br/><br/>
Example Values
issue, issuewild, iodef
Example Default Value
issue
No*
issue string Help Entry
Enter the domain of the Certificate authority (ex. letsencrypt.org). To prevent Certificate Authorities from issuing certificates for this tag enter a semicolon (;).
Example Values
comodoca.com, digicert.com, entrust.net, globalsign.com, izenpe.com, letsencrypt.org, symantec.com, trustwave.com, wosign.com, ;
No
issuewild string Help Entry
Enter the domain of the Certificate authority (ex. letsencrypt.org). To prevent Certificate Authorities from issuing certificates for this tag enter a semicolon (;).
Example Values
comodoca.com, digicert.com, entrust.net, globalsign.com, izenpe.com, letsencrypt.org, symantec.com, trustwave.com, wosign.com, ;
No
iodef string Help Entry
Enter an email address or url to receive IODEF incident reports. See <a href="https://tools.ietf.org/html/rfc6546">[RFC6546]</a> for more information regarding url reporting.
No
* indicates that it’s actually required, but probably already has a valid default value
Action: addCNAME
Added in version 4.8.0-393
Description Add a CNAME record to a zone.
Input Parameters
Name Type Notes Required?
zone_id integer Yes
host string Example Default Value
{domain}
No*
ttl integer Description
In Seconds
Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Example Default Value
43200
No*
alias string Yes
* indicates that it’s actually required, but probably already has a valid default value
Action: addMX
Added in version 4.8.0-393
Description Add an MX record to a zone.
Input Parameters
Name Type Notes Required?
zone_id integer Yes
host string Example Default Value
{domain}
No*
ttl integer Description
In Seconds
Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Example Default Value
43200
No*
preference integer Help Entry
An integer, ranging from 0-65535, indicating the order in which records should be attempted. Lower numbers will be processed before higher ones.
Yes
mail_server string Yes
* indicates that it’s actually required, but probably already has a valid default value
Action: addNAPTR
Added in version 4.8.0-393
Description Add an NAPTR record to a zone.
Input Parameters
Name Type Notes Required?
zone_id integer Yes
domain string Example Default Value
{domain}
No*
ttl integer Description
In Seconds
Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Example Default Value
43200
No*
order integer Help Entry
An integer, ranging from 0-65535, indicating the order in which records MUST be processed by a client. Lower numbers will be processed before higher ones. Once a client has matched a record, that client will stop looking for records with a higher order.
Example Default Value
10
No*
preference integer Help Entry
An integer, ranging from 0-65535, indicating the order in which records SHOULD be processed by a client. Lower numbers will be processed before higher ones. Once a client has matched a record, that client may consider records with a higher Preference. This is similar to the preference of an MX record.
Example Default Value
100
No*
flag string Example Values
S, A, U, P
Yes
service string No
regex string No
replacement string Help Entry
The next name to query for additional records. This must be a Fully Qualified Domain Name (FQDN).
No
* indicates that it’s actually required, but probably already has a valid default value
Action: addNS
Added in version 4.8.0-393
Description Add an NS record to a zone.
Input Parameters
Name Type Notes Required?
zone_id integer Yes
host string Example Default Value
{domain}
No*
ttl integer Description
In Seconds
Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Example Default Value
43200
No*
nameserver string Yes
* indicates that it’s actually required, but probably already has a valid default value
Action: addPTR
Added in version 4.8.0-393
Description Add a PTR record to a zone.
Input Parameters
Name Type Notes Required?
zone_id integer Yes
ip_data string Help Entry
The IP Data for a PTR record can be entered in several formats.<ul><li>Normal IPv4 - 1.2.3.4</li><li>Normal IPv6 - beef::12fe</li><li>Hostname - 4.3.2.1.in-addr.arpa</li><li>RFC4183-style - 4.3/29.2.1.in-addr.arpa</li></ul>
No*
ttl integer Description
In Seconds
Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Example Default Value
43200
No*
domain string Example Default Value
{domain}
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: addSOA
Added in version 4.8.0-393
Description Add an SOA record to a zone.
Input Parameters
Name Type Notes Required?
zone_id integer Yes
host string Example Default Value
{domain}
No*
nameserver string 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.
Yes
email string 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).
Yes
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).
Yes
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).
Yes
expiration 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.
Yes
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.
Yes
* indicates that it’s actually required, but probably already has a valid default value
Action: addSPF
Added in version 4.8.0-393
Description Add an SPF record to a zone.
Input Parameters
Name Type Notes Required?
zone_id integer Yes
host string Example Default Value
{domain}
No*
ttl integer Description
In Seconds
Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Example Default Value
43200
No*
spf_record_value string No
spf_version string Example Values
v=spf1, v=spf3
Example Default Value
v=spf1
No*
use_a integer Description
Should the IP(s) referenced in DNS A Records for this domain be permitted to send mail?
Example Values
1, 0
Example Default Value
0
No*
use_mx integer Description
Should the hostnames referenced in DNS MX Records for this domain be permitted to send mail?
Example Values
1, 0
Example Default Value
0
No*
use_ptr integer Description
Should the PTR Records for the sender’s IP be used to validate the sender’s domain? NOT RECOMMENDED.
Example Values
1, 0
Example Default Value
0
No*
other_servers integer Description
Do any other hostnames or IPs need to be authorized to send mail for this domain?
Example Values
1, 0
Example Default Value
0
No*
mechanism_a struct (string) Description
If the domain name has an address record (A or AAAA) that can be resolved to the sender’s address, it will match.
No
mechanism_mx struct (string) Description
If the domain name has an MX record resolving to the sender’s address, it will match (i.e. the mail comes from one of the domain’s mail servers).
No
mechanism_ip4 struct (string) Description
If the sender is in a given IPv4 range, match.
No
mechanism_ip6 struct (string) Description
If the sender is in a given IPv6 range, match.
No
mechanism_ptr struct (string) Description
If the domain name for the client’s address is in the given domain and that domain name resolves to the client’s address, match. Input may use macro-expansion. NOT RECOMMENDED.
No
mechanism_exists struct (string) Description
If there is a valid A Record for the given domain, match. Input may use macro-expansion.
No
mechanism_include struct (string) Description
Used to include the policies of another domain’s SPF record. Similar to the ’Redirect’ parameter.
No
all string Description
Defines how to respond if the record has produced no match.
Example Values
, -all, ~all, ?all, +all
No
redirect string Description
Redirects verification to use the SPF record of the specified domain. This is useful, for example, if you send mail through your ISP’s servers and they have defined an SPF record.
No
explanation string Description
Defines a DNS name whose TXT Record may be returned along with failure messages. Rarely used, may not be universally supported.
No
* indicates that it’s actually required, but probably already has a valid default value
Action: addSRV
Added in version 4.8.0-393
Description Add an SRV record to a zone.
Input Parameters
Name Type Notes Required?
zone_id integer Yes
service string Help Entry
The symbolic name of the desired service. For example, _sip, _ldap, etc.
Yes
protocol string Help Entry
The name of the protocol with an underscore prepended to avoid collisions with other DNS records. "_TCP" and "_UDP" are the two most common values.
Yes
domain string Example Default Value
{domain}
No*
ttl integer Description
In Seconds
Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Example Default Value
43200
No*
priority integer Yes
weight integer Yes
port integer Yes
target string Yes
* indicates that it’s actually required, but probably already has a valid default value
Action: addTXT
Added in version 4.8.0-393
Description Add a TXT record to a zone.
Input Parameters
Name Type Notes Required?
zone_id integer Yes
host string Example Default Value
{domain}
No*
ttl integer Description
In Seconds
Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Example Default Value
43200
No*
text string Yes
* indicates that it’s actually required, but probably already has a valid default value
Action: delete
Added in version 4.7.0-339
Description Delete a DNS record.
Input Parameters
Name Type Notes Required?
record_id struct (integer) Yes
Action: edit
Added in version 4.7.0-339
Description Edit a DNS record.
Warning This action has been deprecated as of version 4.8.0-393. 2011-02-23 Use the individual edit(record-type) functions instead.
Input Parameters
Name Type Notes Required?
record_id integer Yes
host string Example Default Value
{domain}
No*
type string Example Values
A, CNAME, NS, MX, PTR, TXT, SOA, SPF, SRV, AAAA, NAPTR, CAA
Example Default Value
SOA
No*
target string Example Default Value
{domain} testmaster@{domain} 7200 300 1209600 10800
No*
ttl integer Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Example Default Value
43200
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: editA
Added in version 4.7.0-339
Description Edit an A record.
Input Parameters
Name Type Notes Required?
record_id integer Yes
host string Example Default Value
{domain}
No*
ttl integer Description
In Seconds
Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Example Default Value
43200
No*
ipaddress string Help Entry
####
Example Default Value
{ipv4}
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: editAAAA
Added in version 4.8.0-393
Description Edit an AAAA record.
Input Parameters
Name Type Notes Required?
record_id integer Yes
host string Example Default Value
{domain}
No*
ttl integer Description
In Seconds
Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Example Default Value
43200
No*
ipaddress string Help Entry
####
Example Default Value
{ipv6}
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: editCAA
Added in version 6.0.8-1363
Description Edit a CAA record.
Input Parameters
Name Type Notes Required?
record_id integer Yes
domain string Example Default Value
example.com
No*
ttl integer Description
In Seconds
Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Example Default Value
43200
No*
flags integer Help Entry
Issuer Critical Flag: If the "flags" value is set to ’1’, the critical flag is asserted and the property MUST be understood if the CAA record is to be correctly processed by a certificate issuer. A Certification Authority MUST NOT issue certificates for any Domain that contains a CAA critical property for an unknown or unsupported property tag that for which the issuer critical flag is set. See: RFC6844
Example Values
0, 128
Example Default Value
0
No*
tag string Help Entry
Property tags define the meaning of the CAA record. Three are currently supported, but more may be added in the future.<br/><br/><b>issue:</b>This tag is used to allow/disallow the Certificate Authority to issue certificates for the domain, including wildcard certificates.<br/><br/><b>issuewild: </b>This tag is used to allow/disallow wildcard certificates issuance for the domain.<br/><br/><b>iodef: </b>This tag specifies a method for CAs to report to the domain holder when a certificate is issued. Not all CAs support this tag, so there is no guarantee that all certificate issuances will be reported.<br/><br/>
Example Values
issue, issuewild, iodef
Example Default Value
issue
No*
issue string Help Entry
Enter the domain of the Certificate authority (ex. letsencrypt.org). To prevent Certificate Authorities from issuing certificates for this tag enter a semicolon (;).
Example Values
comodoca.com, digicert.com, entrust.net, globalsign.com, izenpe.com, letsencrypt.org, symantec.com, trustwave.com, wosign.com, ;
Example Default Value
ca.example.net
No
issuewild string Help Entry
Enter the domain of the Certificate authority (ex. letsencrypt.org). To prevent Certificate Authorities from issuing certificates for this tag enter a semicolon (;).
Example Values
comodoca.com, digicert.com, entrust.net, globalsign.com, izenpe.com, letsencrypt.org, symantec.com, trustwave.com, wosign.com, ;
No
iodef string Help Entry
Enter an email address or url to receive IODEF incident reports. See <a href="https://tools.ietf.org/html/rfc6546">[RFC6546]</a> for more information regarding url reporting.
No
* indicates that it’s actually required, but probably already has a valid default value
Action: editCNAME
Added in version 4.8.0-393
Description Edit a CNAME record.
Input Parameters
Name Type Notes Required?
record_id integer Yes
host string Example Default Value
www.{domain}
No*
ttl integer Description
In Seconds
Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Example Default Value
43200
No*
alias string Example Default Value
{domain}
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: editMX
Added in version 4.8.0-393
Description Edit a MX record.
Input Parameters
Name Type Notes Required?
record_id integer Yes
host string Example Default Value
{domain}
No*
ttl integer Description
In Seconds
Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Example Default Value
43200
No*
preference integer Help Entry
An integer, ranging from 0-65535, indicating the order in which records should be attempted. Lower numbers will be processed before higher ones.
Example Default Value
10
No*
mail_server string Example Default Value
mail.{domain}
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: editNAPTR
Added in version 4.8.0-393
Description Edit a NAPTR record.
Input Parameters
Name Type Notes Required?
record_id integer Yes
domain string Example Default Value
example.com
No*
ttl integer Description
In Seconds
Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Example Default Value
43200
No*
order integer Help Entry
An integer, ranging from 0-65535, indicating the order in which records MUST be processed by a client. Lower numbers will be processed before higher ones. Once a client has matched a record, that client will stop looking for records with a higher order.
Example Default Value
10
No*
preference integer Help Entry
An integer, ranging from 0-65535, indicating the order in which records SHOULD be processed by a client. Lower numbers will be processed before higher ones. Once a client has matched a record, that client may consider records with a higher Preference. This is similar to the preference of an MX record.
Example Default Value
100
No*
flag string Example Values
S, A, U, P
Example Default Value
S
No*
service string No
regex string Example Default Value
!^.*$!sip:info@example.com!
No
replacement string Help Entry
The next name to query for additional records. This must be a Fully Qualified Domain Name (FQDN).
Example Default Value
_sip._udp.example.com
No
* indicates that it’s actually required, but probably already has a valid default value
Action: editNS
Added in version 4.8.0-393
Description Edit a NS record.
Input Parameters
Name Type Notes Required?
record_id integer Yes
host string Example Default Value
{domain}
No*
ttl integer Description
In Seconds
Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Example Default Value
43200
No*
nameserver string Example Default Value
ns1.interworx.com
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: editPTR
Added in version 4.8.0-393
Description Edit a PTR record.
Input Parameters
Name Type Notes Required?
record_id integer Yes
ip_data string Help Entry
The IP Data for a PTR record can be entered in several formats.<ul><li>Normal IPv4 - 1.2.3.4</li><li>Normal IPv6 - beef::12fe</li><li>Hostname - 4.3.2.1.in-addr.arpa</li><li>RFC4183-style - 4.3/29.2.1.in-addr.arpa</li></ul>
Example Default Value
4.3.2.1.in-addr.arpa
No*
ttl integer Description
In Seconds
Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Example Default Value
43200
No*
domain string Example Default Value
example.com
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: editSOA
Added in version 4.8.0-393
Description Edit an SOA record.
Input Parameters
Name Type Notes Required?
record_id integer Yes
nameserver string 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*
email string 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*
expiration 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: editSPF
Added in version 4.8.0-393
Description Edit an SPF record.
Input Parameters
Name Type Notes Required?
record_id integer Yes
host string Example Default Value
example.com
No*
ttl integer Description
In Seconds
Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Example Default Value
43200
No*
spf_record_value string Example Default Value
v=spf1
No
spf_version string Example Values
v=spf1, v=spf3
Example Default Value
v=spf1
No*
use_a integer Description
Should the IP(s) referenced in DNS A Records for this domain be permitted to send mail?
Example Values
1, 0
Example Default Value
0
No*
use_mx integer Description
Should the hostnames referenced in DNS MX Records for this domain be permitted to send mail?
Example Values
1, 0
Example Default Value
0
No*
use_ptr integer Description
Should the PTR Records for the sender’s IP be used to validate the sender’s domain? NOT RECOMMENDED.
Example Values
1, 0
Example Default Value
0
No*
other_servers integer Description
Do any other hostnames or IPs need to be authorized to send mail for this domain?
Example Values
1, 0
Example Default Value
0
No*
mechanism_a struct (string) Description
If the domain name has an address record (A or AAAA) that can be resolved to the sender’s address, it will match.
No
mechanism_mx struct (string) Description
If the domain name has an MX record resolving to the sender’s address, it will match (i.e. the mail comes from one of the domain’s mail servers).
No
mechanism_ip4 struct (string) Description
If the sender is in a given IPv4 range, match.
No
mechanism_ip6 struct (string) Description
If the sender is in a given IPv6 range, match.
No
mechanism_ptr struct (string) Description
If the domain name for the client’s address is in the given domain and that domain name resolves to the client’s address, match. Input may use macro-expansion. NOT RECOMMENDED.
No
mechanism_exists struct (string) Description
If there is a valid A Record for the given domain, match. Input may use macro-expansion.
No
mechanism_include struct (string) Description
Used to include the policies of another domain’s SPF record. Similar to the ’Redirect’ parameter.
No
all string Description
Defines how to respond if the record has produced no match.
Example Values
, -all, ~all, ?all, +all
No
redirect string Description
Redirects verification to use the SPF record of the specified domain. This is useful, for example, if you send mail through your ISP’s servers and they have defined an SPF record.
No
explanation string Description
Defines a DNS name whose TXT Record may be returned along with failure messages. Rarely used, may not be universally supported.
No
* indicates that it’s actually required, but probably already has a valid default value
Action: editSRV
Added in version 4.8.0-393
Description Edit an SRV record.
Input Parameters
Name Type Notes Required?
record_id integer Yes
service string Help Entry
The symbolic name of the desired service. For example, _sip, _ldap, etc.
Example Default Value
_sip
No*
protocol string Help Entry
The name of the protocol with an underscore prepended to avoid collisions with other DNS records. "_TCP" and "_UDP" are the two most common values.
Example Default Value
_tcp
No*
domain string Example Default Value
example.com
No*
ttl integer Description
In Seconds
Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Example Default Value
43200
No*
priority integer Example Default Value
10
No*
weight integer Example Default Value
100
No*
port integer Example Default Value
5060
No*
target string Example Default Value
www.google.com
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: editTXT
Added in version 4.8.0-393
Description Edit a TXT record.
Input Parameters
Name Type Notes Required?
record_id integer Yes
host string Example Default Value
example.com
No*
ttl integer Description
In Seconds
Help Entry
TTL, or Time To Live, is the number of seconds that a record will be considered valid by a server caching the information.
Example Default Value
43200
No*
text string Example Default Value
example text record
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: listRecordIds
Added in version 4.7.0-339
Description List dns records by id.
Warning This action has been deprecated as of version 4.1.0-247. 2009-12-07 use listRecords
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
0 => ’1’,
1 => ’{domain} | SOA | {domain} testmaster@{domain} 7200 300 1209600 10800’,
),
1 =>
array (
0 => ’2’,
1 => ’{domain} | A | {ipv4}’,
),
2 =>
array (
0 => ’3’,
1 => ’ipv4.{domain} | A | {ipv4}’,
),
),
)
Action: listRecords
Added in version 4.7.0-339
Description List dns records by id.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’record_id’ => ’2’,
’zone_id’ => ’1’,
’domain’ => ’1.dns-template.com’,
’type’ => ’A’,
’host’ => ’{domain}’,
’target’ => ’{ipv4}’,
’ttl’ => ’43200’,
’last_update’ => ’1417708438’,
’is_template’ => ’1’,
),
1 =>
array (
’record_id’ => ’3’,
’zone_id’ => ’1’,
’domain’ => ’1.dns-template.com’,
’type’ => ’A’,
’host’ => ’ipv4.{domain}’,
’target’ => ’{ipv4}’,
’ttl’ => ’43200’,
’last_update’ => ’1417708438’,
’is_template’ => ’1’,
),
2 =>
array (
’record_id’ => ’9’,
’zone_id’ => ’1’,
’domain’ => ’1.dns-template.com’,
’type’ => ’A’,
’host’ => ’mail.{domain}’,
’target’ => ’{ipv4}’,
’ttl’ => ’43200’,
’last_update’ => ’1417708438’,
’is_template’ => ’1’,
),
),
)
Action: queryEditA
Added in version 5.1.0-838
Description Displays the information available to the action "editA".
Input Parameters
Name Type Notes Required?
record_id integer Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’host’ => ’1.dns-template.com’,
’ttl’ => ’43200’,
’ipaddress’ => ’1.1.1.1’,
’record_id’ => ’2’,
),
)
Action: queryEditAAAA
Added in version 5.1.0-838
Description Displays the information available to the action "editAAAA".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’host’ => ’1.dns-template.com’,
’ttl’ => ’43200’,
’ipaddress’ => ’1::1’,
’record_id’ => ’4’,
),
)
Action: queryEditCAA
Added in version 6.0.8-1363
Description Displays the information available to the action "editCAA".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’domain’ => ’example.com’,
’ttl’ => ’43200’,
’flags’ => ’0’,
’tag’ => ’issue’,
’issue’ => ’ca.example.net’,
’issuewild’ => ’’,
’iodef’ => ’’,
’record_id’ => ’8256’,
),
)
Action: queryEditCNAME
Added in version 5.1.0-838
Description Displays the information available to the action "editCNAME".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’host’ => ’www.1.dns-template.com’,
’ttl’ => ’43200’,
’alias’ => ’1.dns-template.com’,
’record_id’ => ’6’,
),
)
Action: queryEditMX
Added in version 5.1.0-838
Description Displays the information available to the action "editMX".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’host’ => ’1.dns-template.com’,
’ttl’ => ’43200’,
’preference’ => ’10’,
’mail_server’ => ’mail.1.dns-template.com’,
’record_id’ => ’8’,
),
)
Action: queryEditNAPTR
Added in version 5.1.0-838
Description Displays the information available to the action "editNAPTR".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’domain’ => ’example.com’,
’ttl’ => ’43200’,
’order’ => ’10’,
’preference’ => ’100’,
’flag’ => ’S’,
’service’ => ’’,
’regex’ => ’!^.*$!sip:info@example.com!’,
’replacement’ => ’_sip._udp.example.com’,
’record_id’ => ’8255’,
),
)
Action: queryEditNS
Added in version 5.1.0-838
Description Displays the information available to the action "editNS".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’host’ => ’1.dns-template.com’,
’ttl’ => ’43200’,
’nameserver’ => ’ns1.interworx.com’,
’record_id’ => ’506’,
),
)
Action: queryEditPTR
Added in version 5.1.0-838
Description Displays the information available to the action "editPTR".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’ip_data’ => ’4.3.2.1.in-addr.arpa’,
’ttl’ => ’43200’,
’domain’ => ’example.com’,
’record_id’ => ’8257’,
),
)
Action: queryEditSOA
Added in version 5.1.0-838
Description Displays the information available to the action "editSOA".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’host’ => ’1.dns-template.com’,
’nameserver’ => ’1.dns-template.com’,
’email’ => ’testmaster@1.dns-template.com’,
’refresh’ => ’7200’,
’retry’ => ’300’,
’expiration’ => ’1209600’,
’negative_ttl’ => ’10800’,
’record_id’ => ’1’,
),
)
Action: queryEditSPF
Added in version 5.1.0-838
Description Displays the information available to the action "editSPF".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’host’ => ’example.com’,
’ttl’ => ’43200’,
’spf_record_value’ => ’v=spf1’,
’spf_version’ => ’v=spf1’,
’use_a’ => ’0’,
’use_mx’ => ’0’,
’use_ptr’ => ’0’,
’other_servers’ => ’0’,
’mechanism_a’ =>
array (
),
’mechanism_mx’ =>
array (
),
’mechanism_ip4’ =>
array (
),
’mechanism_ip6’ =>
array (
),
’mechanism_ptr’ =>
array (
),
’mechanism_exists’ =>
array (
),
’mechanism_include’ =>
array (
),
’all’ => NULL,
’redirect’ => ’’,
’explanation’ => NULL,
’record_id’ => ’8258’,
),
)
Action: queryEditSRV
Added in version 5.1.0-838
Description Displays the information available to the action "editSRV".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’service’ => ’_sip’,
’protocol’ => ’_tcp’,
’domain’ => ’example.com’,
’ttl’ => ’43200’,
’priority’ => ’10’,
’weight’ => ’100’,
’port’ => ’5060’,
’target’ => ’www.google.com’,
’record_id’ => ’8259’,
),
)
Action: queryEditTXT
Added in version 5.1.0-838
Description Displays the information available to the action "editTXT".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’host’ => ’example.com’,
’ttl’ => ’43200’,
’text’ => ’example text record’,
’record_id’ => ’8260’,
),
)
Action: queryRecords
Added in version 4.7.0-339
Description Query DNS Records.
Input Parameters
Name Type Notes Required?
zone_id integer No
domain struct (string) Example Values
example.com, pointer.com, secondary.com
No
type struct (string) Example Values
A, CNAME, NS, MX, PTR, TXT, SOA, SPF, SRV, AAAA, NAPTR, CAA
No
last_update string No
uni integer Example Values
1, 0
Example Default Value
0
No*
show_domain integer Example Values
1, 0
Example Default Value
1
No*
* indicates that it’s actually required, but probably already has a valid default value

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

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 => ’636’,
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’ => ’637’,
’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’ => ’638’,
’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

14 Controller: /nodeworx/firewall

Required Permissions "FIREWALL"
Action: addPort
Added in version 4.7.0-339
Description Add a port to the firewall configuration.
Input Parameters
Name Type Notes Required?
port string Help Entry
Enter the port or ports you wish to add to the firewall. You can enter port ranges as well, ex: 1234-1236.
Yes
tcp_flow_in string Example Values
open, closed
Yes
tcp_flow_out string Example Values
open, closed
Yes
udp_flow_in string Example Values
open, closed
Yes
udp_flow_out string Example Values
open, closed
Yes
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: allowDenyIps
Added in version 4.7.0-339
Description Set firewall ip address allow and deny lists.
Input Parameters
Name Type Notes Required?
trusted_ips struct (string) Help Entry
The IP address for license.interworx.info (207.32.181.150) must be present for proper function of the InterWorx license authentication system.
Example Default Value
{"127.0.0.1":"127.0.0.1"}
No
blocked_ips struct (string) No
Action: delete
Added in version 4.7.0-339
Description Delete firewall port configuration.
Input Parameters
Name Type Notes Required?
ports struct (string) Example Values
21, 22, 23, 25, 80, 110, 143, 443, 993, 995, 2080, 2443, 3306, 50000_51000, 4444, 20, 53
Yes
Action: ipv6Settings
Added in version 5.0.14-579
Description Controls how IPv6 Settings are handled when restarting the firewall.
Input Parameters
Name Type Notes Required?
ip6tables_status string Example Values
off, manual, managed
Example Default Value
manual
No*
icmp6_control string Example Values
default, managed
Example Default Value
managed
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: isRunning
Added in version 4.7.0-339
Description Checks if the service is running or not.
Sample output
array (
’status’ => 0,
’payload’ => false,
)
Action: isRunningOnNode
Added in version 4.7.0-339
Description Checks if the service is running on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: listGeneralName
Added in version 4.7.0-339
Description Lists the "normal" name - ie "web server" instead of "httpd".
Sample output
array (
’status’ => 0,
’payload’ => ’##LG_FIREWALL##’,
)
Action: listPortNumbers
Added in version 4.7.0-339
Description Lists a string of the port numbers that this service uses, comma-seperated.
Sample output
array (
’status’ => 0,
’payload’ => ’##LG_NOT_APPLICABLE##’,
)
Action: listPortNumbersArray
Added in version 4.7.0-339
Description Lists array of port numbers and ranges that this service uses.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’##LG_NOT_APPLICABLE##’,
),
)
Action: listRequiredPermissions
Added in version 4.7.0-339
Description Lists an array of permissions required to control the service.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’FIREWALL’,
),
)
Action: listServiceInfo
Added in version 4.7.0-339
Description Lists the service name, ports, page, and status.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’id’ => ’apf’,
’name’ => ’##LG_FIREWALL##’,
’ports’ => ’##LG_NOT_APPLICABLE##’,
’page’ => ’/nodeworx/firewall’,
’ctrl’ => ’/nodeworx/firewall’,
’is_running’ => 0,
),
)
Action: listServiceName
Added in version 4.7.0-339
Description Lists the service name - ie "httpd" instead of "web server".
Sample output
array (
’status’ => 0,
’payload’ => ’apf’,
)
Action: listServicePage
Added in version 4.7.0-339
Description Lists the page that controls the service.
Sample output
array (
’status’ => 0,
’payload’ => ’/nodeworx/firewall’,
)
Action: queryAllowDenyIps
Added in version 5.1.0-838
Description Displays the information available to the action "allowDenyIps".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’trusted_ips’ =>
array (
’127.0.0.1’ => ’127.0.0.1’,
),
’blocked_ips’ =>
array (
),
),
)
Action: queryIpv6Settings
Added in version 5.1.0-838
Description Displays the information available to the action "ipv6Settings".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’ip6tables_status’ => ’manual’,
’icmp6_control’ => ’managed’,
),
)
Action: queryPortAccess
Added in version 5.0.14-579
Description Query firewall port options.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’service’ => ’ftp-data’,
’port’ => 20,
’tcp_in’ => ’closed’,
’tcp_out’ => ’closed’,
’udp_in’ => ’open’,
’udp_out’ => ’open’,
),
1 =>
array (
’service’ => ’ftp’,
’port’ => 21,
’tcp_in’ => ’open’,
’tcp_out’ => ’closed’,
’udp_in’ => ’open’,
’udp_out’ => ’open’,
),
2 =>
array (
’service’ => ’ssh’,
’port’ => 22,
’tcp_in’ => ’open’,
’tcp_out’ => ’open’,
’udp_in’ => ’closed’,
’udp_out’ => ’closed’,
),
),
)
Action: queryUpdateConfig
Added in version 5.1.0-838
Description Displays the information available to the action "updateConfig".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’version’ => ’1.7.5 (APF)’,
’debug_mode’ => ’0’,
’default_tos’ => ’4’,
’tcp_drop_policy’ => ’DROP’,
’udp_drop_policy’ => ’DROP’,
’block_multicast’ => ’0’,
’block_private_network’ => ’0’,
’set_egress_filter’ => ’0’,
’max_sessions’ => ’34576’,
’sysctl_tcp’ => ’1’,
’if’ => ’eth0’,
’tifs’ =>
array (
),
),
)
Action: restart
Added in version 4.7.0-339
Description Restarts the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: restartOnNode
Added in version 4.7.0-339
Description Restarts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: start
Added in version 4.7.0-339
Description Starts the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: startOnBoot
Added in version 4.7.0-339
Description Set the firewall start-on-boot status.
Input Parameters
Name Type Notes Required?
startonboot integer Example Values
1, 0
Example Default Value
0
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: startOnNode
Added in version 4.7.0-339
Description Starts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: stop
Added in version 4.7.0-339
Description Stops the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: stopOnNode
Added in version 4.7.0-339
Description Stops the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: update
Added in version 4.7.0-339
Description Update a port in the firewall configuration.
Input Parameters
Name Type Notes Required?
tcp_flow_in string Example Values
none, open, closed
No
tcp_flow_out string Example Values
none, open, closed
No
udp_flow_in string Example Values
none, open, closed
No
udp_flow_out string Example Values
none, open, closed
No
Action: updateConfig
Added in version 4.7.0-339
Description Update basic firewall configuration.
Input Parameters
Name Type Notes Required?
debug_mode integer Help Entry
When debug mode is enabled, all firewall rules are flushed every 5 minutes to prevent being locked out of the server due to a firewall misconfiguration.
Example Values
1, 0
Example Default Value
0
No*
default_tos integer Help Entry
Defines the default type of service.
Example Values
4, 8, 16
Example Default Value
4
No*
tcp_drop_policy string Help Entry
Defines how to handle TCP packet filtering. ’Reset’ sends a tcp-reset message, ’Drop’ silently drops the packet, and ’Reject’ rejects the packet.
Example Values
RESET, DROP, REJECT
Example Default Value
DROP
No*
udp_drop_policy string Help Entry
Defines how to handle UDP packet filtering. ’Reset’ sends an icmp-port-unreachable message, ’Drop’ will silently drop the packet, ’Reject’ will reject the packet, and ’Prohibit’ will send an icmp-host-prohibited message.
Example Values
RESET, DROP, REJECT, PROHIBIT
Example Default Value
DROP
No*
block_multicast integer Help Entry
Defines if the firewall should block multicast traffic.
Example Values
1, 0
Example Default Value
0
No*
block_private_network integer Help Entry
Defines if the firewall should block all private ipv4 addresses (reserved address space, generally unroutable on the internet). If the server sites behind a NAT or other routing setup that would make use of private addressing, leave this option ’Off’.
Example Values
1, 0
Example Default Value
0
No*
set_egress_filter integer Help Entry
Outbound (egress) filtering provides full outbound packet filtering. NOTE: Port specific outbound rules will not apply if this setting is off.
Example Values
1, 0
Example Default Value
0
No*
max_sessions integer Help Entry
Defines the maximum number of connection tracking entries that can be handled by the firewall simultaneously.
Example Default Value
34576
No*
sysctl_tcp integer Help Entry
Enables or Disables sysctl hook changes to harden the kernel from certain network-based attacks.
Example Values
1, 0
Example Default Value
1
No*
if string Help Entry
All traffic on defined interface will be subject to all firewall rules. This should be your internet exposed interface.
Example Values
eth0
Example Default Value
eth0
No*
tifs struct (string) Help Entry
All traffic on defined interface(s) will bypass ALL firewall rules.
Example Values
eth0
No
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value

15 Controller: /nodeworx/ftp

Required Permissions "FTP"
Action: autoRestart
Added in version 4.7.0-339
Description Set the FTP server auto-restart status.
Input Parameters
Name Type Notes Required?
ftp_autorestart integer Help Entry
With this option on you can have FTP restarted automatically if FTP goes down unexpectedly.
Example Values
1, 0
Example Default Value
0
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: isRunning
Added in version 4.7.0-339
Description Checks if the service is running or not.
Sample output
array (
’status’ => 0,
’payload’ => true,
)
Action: isRunningOnNode
Added in version 4.7.0-339
Description Checks if the service is running on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: killSessions
Added in version 4.8.0-393
Description Kill ftp sessions.
Input Parameters
Name Type Notes Required?
sessions struct (integer) No*
* indicates that it’s actually required, but probably already has a valid default value
Action: listFtpSessions
Added in version 4.8.0-393
Description List Ftp Sessions.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
),
)
Action: listGeneralName
Added in version 4.7.0-339
Description Lists the "normal" name - ie "web server" instead of "httpd".
Sample output
array (
’status’ => 0,
’payload’ => ’##LG_FTPSERVER##’,
)
Action: listPortNumbers
Added in version 4.7.0-339
Description Lists a string of the port numbers that this service uses, comma-seperated.
Sample output
array (
’status’ => 0,
’payload’ => ’21’,
)
Action: listPortNumbersArray
Added in version 4.7.0-339
Description Lists array of port numbers and ranges that this service uses.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => 21,
),
)
Action: listRequiredPermissions
Added in version 4.7.0-339
Description Lists an array of permissions required to control the service.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’FTP’,
),
)
Action: listServiceInfo
Added in version 4.7.0-339
Description Lists the service name, ports, page, and status.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’id’ => ’proftpd’,
’name’ => ’##LG_FTPSERVER##’,
’ports’ => ’21’,
’page’ => ’/nodeworx/ftp’,
’ctrl’ => ’/nodeworx/ftp’,
’is_running’ => 1,
),
)
Action: listServiceName
Added in version 4.7.0-339
Description Lists the service name - ie "httpd" instead of "web server".
Sample output
array (
’status’ => 0,
’payload’ => ’proftpd’,
)
Action: listServicePage
Added in version 4.7.0-339
Description Lists the page that controls the service.
Sample output
array (
’status’ => 0,
’payload’ => ’/nodeworx/ftp’,
)
Action: queryAutoRestart
Added in version 5.1.0-838
Description Displays the information available to the action "autoRestart".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’ftp_autorestart’ => ’0’,
),
)
Action: queryEditConf
Added in version 5.1.0-838
Description Displays the information available to the action "editConf".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’file’ => ’/etc/proftpd.conf’,
’file_content’ => ’####
## InterWorx-CP Proftpd config
####
##
# Global Environment
##
ServerName "InterWorx-CP :: FTP Server"
ServerType standalone
ServerIdent on "FTP Server Ready"
PassivePorts 50000 51000
ListOptions -a
DefaultServer on
DeferWelcome on
SyslogLevel debug
UseReverseDNS off
UseFtpUsers off
IdentLookups off
WtmpLog off
ScoreboardFile /var/run/proftpd/proftpd-scoreboard
DisplayLogin /etc/motd
SetEnv TZ :/etc/localtime
##
# Basic Defaults
##
Port 21
Umask 022
##
# Timeouts
##
TimeoutLogin 120
TimeoutIdle 600
TimeoutNoTransfer 900
TimeoutStalled 3600
TimeoutSession 0
##
# security stuff
##
MaxInstances 30
RootLogin off
##
# The user/group we run as
##
User proftpd
Group proftpd
##
# Logging formats
##
TransferLog NONE
LogFormat default "%h %l %u %t \\"%m %f\\" %s %b"
LogFormat auth "%v [%P] %h %t \\"%r\\" %s"
LogFormat xfer "%h %l %u %t \\"%m %f\\" %s %b"
LogFormat byte "%u %b"
## system log
SystemLog /var/log/proftpd/auth.log
##
# Global settings
##
<Global>
##
# Basic stuff
##
DisplayLogin welcome.msg
DisplayChdir readme
ShowSymlinks on
AllowOverwrite on
TimesGMT off
AuthOrder mod_sql.c mod_auth_pam.c mod_auth_unix.c
##
# File upload/download resume
##
AllowRetrieveRestart on
AllowStoreRestart on
##
# SQL Authentication
##
SQLAuthenticate users*
SQLConnectInfo iworx_ftp@127.0.0.1:2307 iworx_ftp nwb4iPz9Y5Yg
SQLAuthTypes Crypt
SQLUserWhereClause "1"
SQLMinUserUID 500
SQLMinUserGID 500
SQLDefaultUID 65533
SQLDefaultGID 65533
CreateHome off
SQLUserInfo users username password uid gid homedir shell
SQLGroupInfo groups groupname gid members
##
# Security stuff
##
MaxLoginAttempts 3
RequireValidShell off
MaxClients 25
## chroot everyone
DefaultRoot ~ !wheel
## hide root\’s stuff
<Directory />
HideUser root
HideGroup root
HideGroup wheel
</Directory>
##
# Logging
##
## xfer log
ExtendedLog /var/log/proftpd/xfer.log READ,WRITE xfer
</Global>
<IfModule mod_sftp.c>
<VirtualHost 0.0.0.0>
SFTPEngine on
SFTPLog /var/log/proftpd/sftp.log
ServerIdent off
# Configure the server to listen on the normal SSH2 port, port 22
Port 24
# Configure both the RSA and DSA host keys, using the same host key
# files that OpenSSH uses.
SFTPHostKey /etc/ssh/ssh_host_rsa_key
SFTPHostKey /etc/ssh/ssh_host_dsa_key
# Configure the file used for comparing authorized public keys of users.
SFTPAuthorizedUserKeys file:~/.sftp/authorized_keys
# Enable compression
SFTPCompression delayed
# Allow the same number of authentication attempts as OpenSSH.
#
# It is recommended that you explicitly configure MaxLoginAttempts
# for your SSH2/SFTP instance to be higher than the normal
# MaxLoginAttempts value for FTP, as there are more ways to authenticate
# using SSH2.
MaxLoginAttempts 6
</VirtualHost>
</IfModule>
<IfModule mod_tls.c>
TLSEngine on
TLSLog /var/log/proftpd/tls.log
TLSProtocol SSLv23 # this selects the latest crypt version
TLSOptions NoCertRequest # this is REALLY important for WinClients
# Are clients required to use FTP over TLS when talking to this server?
TLSRequired off
# Server\’s certificate
TLSRSACertificateFile /etc/pki/tls/certs/proftpd.pem
TLSRSACertificateKeyFile /etc/pki/tls/certs/proftpd.pem
# CA the server trusts
# TLSCACertificateFile /usr/share/ssl/cert.pem
# Authenticate clients that want to use FTP over TLS?
TLSVerifyClient off
</IfModule>
maxclientsperuser none
’,
),
)
Action: queryServerOptions
Added in version 5.1.0-838
Description Displays the information available to the action "serverOptions".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’maxinstances’ => ’30’,
’maxclients’ => ’25’,
’maxclientsperuser’ => ’999999999’,
’timeoutlogin’ => ’120’,
’timeoutidle’ => ’600’,
’timeoutnotransfer’ => ’900’,
’timeoutstalled’ => ’3600’,
’timeoutsession’ => ’0’,
’maxloginattempts’ => ’3’,
’tlsrequired’ => ’0’,
’showsymlinks’ => ’1’,
’allowretrieverestart’ => ’1’,
’allowstorerestart’ => ’1’,
),
)
Action: querySftpOptions
Added in version 5.1.0-838
Description Displays the information available to the action "sftpOptions".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’port’ => ’24’,
’maxloginattempts’ => ’6’,
’sftpengine’ => ’1’,
),
)
Action: restart
Added in version 4.7.0-339
Description Restarts the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: restartOnNode
Added in version 4.7.0-339
Description Restarts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: rrdGraph
Added in version 4.7.0-339
Description Set the FTP connections RRD graph display in the web interface.
Input Parameters
Name Type Notes Required?
rrd integer Help Entry
Use the dropdown to turn the FTP server activity graph on or off
Example Values
1, 0
Example Default Value
0
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: serverOptions
Added in version 4.7.0-339
Description Update FTP server settings.
Input Parameters
Name Type Notes Required?
maxinstances integer Help Entry
Sets the maximum number of child processes to be spawned
Example Default Value
30
No*
maxclients integer Help Entry
The total number of FTP clients allowed to connect to the FTP server.
Example Default Value
25
No*
maxclientsperuser integer Help Entry
The total number of FTP clients allowed to connect from a given user id.
Example Default Value
999999999
No*
timeoutlogin integer Help Entry
Sets the login timeout
Example Default Value
120
No*
timeoutidle integer Help Entry
Sets the idle timeout
Example Default Value
600
No*
timeoutnotransfer integer Help Entry
Sets the connection without transfer timeout
Example Default Value
900
No*
timeoutstalled integer Help Entry
Sets the timeout on stalled downloads
Example Default Value
3600
No*
timeoutsession integer Help Entry
Sets a timeout for an entire session
Example Default Value
0
No*
maxloginattempts integer Help Entry
Sets how many password attempts are allowed before disconnection
Example Default Value
3
No*
tlsrequired integer Help Entry
Toggle whether FTPS (secure FTP) is required on this server
Example Values
1, 0
Example Default Value
0
No*
showsymlinks integer Help Entry
Toggle the display of symlinks
Example Values
1, 0
Example Default Value
1
No*
allowretrieverestart integer Help Entry
Allow clients to resume uploads
Example Values
1, 0
Example Default Value
1
No*
allowstorerestart integer Help Entry
Allow clients to resume downloads
Example Values
1, 0
Example Default Value
1
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: sftpOptions
Added in version 4.9.0-427
Description Update SFTP server settings.
Input Parameters
Name Type Notes Required?
port integer Help Entry
The port used for the SFTP service.
Example Default Value
24
No*
maxloginattempts integer Help Entry
Sets how many password attempts are allowed before disconnection
Example Default Value
6
No*
sftpengine integer Help Entry
The current status of the SFTP engine.
Example Values
1, 0
Example Default Value
1
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: start
Added in version 4.7.0-339
Description Starts the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: startOnBoot
Added in version 4.7.0-339
Description Set the FTP server start-on-boot status.
Input Parameters
Name Type Notes Required?
ftp_startonboot integer Help Entry
If set to ’Yes’, FTP will be automatically started when the server starts up
Example Values
1, 0
Example Default Value
1
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: startOnNode
Added in version 4.7.0-339
Description Starts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: stop
Added in version 4.7.0-339
Description Stops the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: stopOnNode
Added in version 4.7.0-339
Description Stops the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value

16 Controller: /nodeworx/health

Required Permissions "SETTINGS"
Action: edit
Added in version 4.7.0-339
Description Edit Problem settings - action has conditional inputs not documented.
Input Parameters
Name Type Notes Required?
code string Example Values
CLAMAV_NOT_WORKING, EXTERNAL_NFS_CANNOT_CONNECT, MAIL_LOGGING_STOPPED, MISSING_NAMEVIRTUALHOSTCONF_FILE, SSL_CERT_EXPIRED, SSL_CERT_NEARLY_EXPIRED, COMMAND_QUEUE_OFFLINE, DEMO_EXPIRE, FIVELY_STUCK, FTP_DB_CONNECTION_BROKEN, HIGH_LOAD, UPGRADE_AVAILABLE, LICENSE, MAIL_QUEUE_SIZE, MISSING_SYMLINK, MULTIPLE_PHP_MODES_ENABLED, PARTITIONS_ALMOST_FULL, PARTITIONS_COMPLETELY_FULL, QUOTAS, RSL_BANDWIDTH, IMAPSSL_OFF, SW_BANDWIDTH, SW_SSL_EXPIRED, SW_SSL_NEARLY_EXPIRED, SW_STORAGE, SWAP_USAGE, TMP_UNWRITEABLE, VPS_CLUSTER, YUM_UPDATE_FAILING, UPGRADE_STEP_FAILED
Yes
repeat_rate string Help Entry
The repeat rate controls how often notices are sent for the conditions checked by the Problem Detectors.
Example Values
once, 0, 30, 60, 1440, 10080
Example Default Value
60
No*
run_time string Help Entry
Controls how often the Detector is run. Detection is triggered by the InterWorx CRON jobs.
Example Values
fively, fifteenly, hourly, quad_daily, daily, weekly, monthly
Example Default Value
hourly
No*
sender_address string Example Values
default
Example Default Value
default
No*
sender_name string Example Values
default
Example Default Value
default
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: editRecipients
Added in version 4.7.0-339
Description Change the recipients of a code.
Input Parameters
Name Type Notes Required?
code string Example Values
CLAMAV_NOT_WORKING, EXTERNAL_NFS_CANNOT_CONNECT, MAIL_LOGGING_STOPPED, MISSING_NAMEVIRTUALHOSTCONF_FILE, SSL_CERT_EXPIRED, SSL_CERT_NEARLY_EXPIRED, COMMAND_QUEUE_OFFLINE, DEMO_EXPIRE, FIVELY_STUCK, FTP_DB_CONNECTION_BROKEN, HIGH_LOAD, UPGRADE_AVAILABLE, LICENSE, MAIL_QUEUE_SIZE, MISSING_SYMLINK, MULTIPLE_PHP_MODES_ENABLED, PARTITIONS_ALMOST_FULL, PARTITIONS_COMPLETELY_FULL, QUOTAS, RSL_BANDWIDTH, IMAPSSL_OFF, SW_BANDWIDTH, SW_SSL_EXPIRED, SW_SSL_NEARLY_EXPIRED, SW_STORAGE, SWAP_USAGE, TMP_UNWRITEABLE, VPS_CLUSTER, YUM_UPDATE_FAILING, UPGRADE_STEP_FAILED
Yes
email_recipients struct (string) Example Values
2, 3, nw1, nw54, nw201
Example Default Value
["2"]
No
banner_recipients struct (string) Help Entry
Banner notices are delivered through the InterWorx interface as a banner across the top of each screen
Example Values
2, 3, nw1, nw54, nw201
Example Default Value
["2"]
No
email_only struct (string) Help Entry
Add direct email addresses to send to
No
Action: queryCodeHistory
Added in version 4.7.0-339
Description Get the code history for a specific code.
Input Parameters
Name Type Notes Required?
code string Example Values
CLAMAV_NOT_WORKING, EXTERNAL_NFS_CANNOT_CONNECT, MAIL_LOGGING_STOPPED, MISSING_NAMEVIRTUALHOSTCONF_FILE, SSL_CERT_EXPIRED, SSL_CERT_NEARLY_EXPIRED, COMMAND_QUEUE_OFFLINE, DEMO_EXPIRE, FIVELY_STUCK, FTP_DB_CONNECTION_BROKEN, HIGH_LOAD, UPGRADE_AVAILABLE, LICENSE, MAIL_QUEUE_SIZE, MISSING_SYMLINK, MULTIPLE_PHP_MODES_ENABLED, PARTITIONS_ALMOST_FULL, PARTITIONS_COMPLETELY_FULL, QUOTAS, RSL_BANDWIDTH, IMAPSSL_OFF, SW_BANDWIDTH, SW_SSL_EXPIRED, SW_SSL_NEARLY_EXPIRED, SW_STORAGE, SWAP_USAGE, TMP_UNWRITEABLE, VPS_CLUSTER, YUM_UPDATE_FAILING, UPGRADE_STEP_FAILED
Yes
Action: queryCodesByEmail
Added in version 4.8.0-393
Description Lists codes that the given email address may recieve.
Input Parameters
Name Type Notes Required?
email string Yes
Action: queryEdit
Added in version 5.1.0-838
Description Displays the information available to the action "edit".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’repeat_rate’ => ’60’,
’run_time’ => ’hourly’,
’sender_address’ => ’default’,
’sender_name’ => ’default’,
’code’ => ’CLAMAV_NOT_WORKING’,
),
)
Action: queryEditRecipients
Added in version 5.1.0-838
Description Displays the information available to the action "editRecipients".
Input Parameters
Name Type Notes Required?
code string Example Values
CLAMAV_NOT_WORKING, EXTERNAL_NFS_CANNOT_CONNECT, MAIL_LOGGING_STOPPED, MISSING_NAMEVIRTUALHOSTCONF_FILE, SSL_CERT_EXPIRED, SSL_CERT_NEARLY_EXPIRED, COMMAND_QUEUE_OFFLINE, DEMO_EXPIRE, FIVELY_STUCK, FTP_DB_CONNECTION_BROKEN, HIGH_LOAD, UPGRADE_AVAILABLE, LICENSE, MAIL_QUEUE_SIZE, MISSING_SYMLINK, MULTIPLE_PHP_MODES_ENABLED, PARTITIONS_ALMOST_FULL, PARTITIONS_COMPLETELY_FULL, QUOTAS, RSL_BANDWIDTH, IMAPSSL_OFF, SW_BANDWIDTH, SW_SSL_EXPIRED, SW_SSL_NEARLY_EXPIRED, SW_STORAGE, SWAP_USAGE, TMP_UNWRITEABLE, VPS_CLUSTER, YUM_UPDATE_FAILING, UPGRADE_STEP_FAILED
Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’email_recipients’ =>
array (
0 => ’2’,
),
’banner_recipients’ =>
array (
0 => ’2’,
),
’email_only’ =>
array (
),
’code’ => ’CLAMAV_NOT_WORKING’,
),
)
Action: queryHealthStatus
Added in version 5.0.14-579
Description Lists real-time status of detectors (actually runs each, be careful about load).
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’code’ => ’CLAMAV_NOT_WORKING’,
’name’ => ’##LG_CLAMAV_NOT_WORKING##’,
’status’ => 0,
’type’ => ’##LG_PROBLEM_SYSTEM_MONITORS##’,
’message’ => ’’,
),
1 =>
array (
’code’ => ’EXTERNAL_NFS_CANNOT_CONNECT’,
’name’ => ’##LG_EXTERNAL_NFS_CANNOT_CONNECT##’,
’status’ => 0,
’type’ => ’##LG_PROBLEM_SYSTEM_MONITORS##’,
’message’ => ’’,
),
2 =>
array (
’code’ => ’MAIL_LOGGING_STOPPED’,
’name’ => ’##LG_MAIL_LOGGING_STOPPED##’,
’status’ => 0,
’type’ => ’##LG_PROBLEM_SYSTEM_MONITORS##’,
’message’ => ’’,
),
),
)
Action: removeTargetFromCode
Added in version 4.8.0-393
Description Removes a specific target from a code. Use queryCodesByEmail() to see targets.
Input Parameters
Name Type Notes Required?
code string Example Values
CLAMAV_NOT_WORKING, EXTERNAL_NFS_CANNOT_CONNECT, MAIL_LOGGING_STOPPED, MISSING_NAMEVIRTUALHOSTCONF_FILE, SSL_CERT_EXPIRED, SSL_CERT_NEARLY_EXPIRED, COMMAND_QUEUE_OFFLINE, DEMO_EXPIRE, FIVELY_STUCK, FTP_DB_CONNECTION_BROKEN, HIGH_LOAD, UPGRADE_AVAILABLE, LICENSE, MAIL_QUEUE_SIZE, MISSING_SYMLINK, MULTIPLE_PHP_MODES_ENABLED, PARTITIONS_ALMOST_FULL, PARTITIONS_COMPLETELY_FULL, QUOTAS, RSL_BANDWIDTH, IMAPSSL_OFF, SW_BANDWIDTH, SW_SSL_EXPIRED, SW_SSL_NEARLY_EXPIRED, SW_STORAGE, SWAP_USAGE, TMP_UNWRITEABLE, VPS_CLUSTER, YUM_UPDATE_FAILING, UPGRADE_STEP_FAILED
Yes
target string Yes

17 Controller: /nodeworx/help

Required Permissions "REMOTEASSIST"
Action: querySsh
Added in version 5.1.0-838
Description Displays the information available to the action "ssh".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’mode’ => ’0’,
’duration’ => ’72 hours’,
),
)
Action: ssh
Added in version 4.8.0-393
Description Enable or disable Interworx Support SSH user.
Input Parameters
Name Type Notes Required?
mode integer Example Values
1, 0
Example Default Value
0
No*
duration string Help Entry
Defines how long Remote Assistance will be enabled before automatically disabling
Example Values
24 hours, 48 hours, 72 hours, 1 week
Example Default Value
72 hours
No
* indicates that it’s actually required, but probably already has a valid default value

18 Controller: /nodeworx/http

Required Permissions "APACHE"
Action: apacheUpdate
Added in version 4.7.0-339
Description Update common apache web server settings.
Input Parameters
Name Type Notes Required?
http_port integer Example Default Value
80
No*
https_port integer Example Default Value
443
No*
serverlimit integer Help Entry
This directive sets the maximum configured value for MaxClients for the lifetime of the web server process.
Example Default Value
256
No*
maxclients integer Help Entry
The MaxClients directive sets the limit on the number of simultaneous requests that will be served.
Example Default Value
256
No*
startservers integer Help Entry
The StartServers directive sets the number of child server processes created on startup. As the number of processes is dynamically controlled depending on the load, there is usually little reason to adjust this parameter.
Example Default Value
8
No*
minspareservers integer Help Entry
Minimum number of idle threads to handle request spikes.
Example Default Value
5
No*
maxspareservers integer Help Entry
This monitors the number of idle threads on a per-child basis. If there are too many idle threads in that child, the server will begin to kill threads within that child.
Example Default Value
20
No*
maxrequestsperchild integer Description
0 is Unlimited
Help Entry
This directive sets the limit on the number of requests that an individual child server process will handle.
Example Default Value
4000
No*
timeout integer Help Entry
This is the length of time before the web server kills the thread handling your connection.
Example Default Value
60
No*
keepalive integer Help Entry
Turn Keepalive on or off.
Example Values
1, 0
Example Default Value
0
No*
maxkeepaliverequests integer Help Entry
The Keep-Alive extension to HTTP/1.0 and the persistent connection feature of HTTP/1.1 provide long-lived HTTP sessions which allow multiple requests to be sent over the same TCP connection.
Example Default Value
100
No*
keepalivetimeout integer Help Entry
The number of seconds the web server will wait for a subsequent request before closing the connection. Once a request has been received, the timeout value specified by the timeout directive applies.
Example Default Value
15
No*
adddefaultcharset string Help Entry
Default value for the media type charset parameter (the name of a character encoding) to be added to a response if and only if the response’s content-type is either text/plain or text/html.
Example Values
UTF-8, ISO-8859-1, UTF-16BE, UTF-16LE, UTF-16, ANSI_X3.4-1968, ISO-10646-UTF-1, ISO_646.basic:1983, INVARIANT, ISO_646.irv:1983, BS_4730, NATS-SEFI, NATS-SEFI-ADD, NATS-DANO, NATS-DANO-ADD, SEN_850200_B, SEN_850200_C, KS_C_5601-1987, ISO-2022-KR, EUC-KR, ISO-2022-JP, ISO-2022-JP-2, ISO-2022-CN, ISO-2022-CN-EXT, JIS_C6220-1969-jp, JIS_C6220-1969-ro, IT, PT, ES, greek7-old, latin-greek, DIN_66003, NF_Z_62-010_(1973), Latin-greek-1, ISO_5427, JIS_C6226-1978, BS_viewdata, INIS, INIS-8, INIS-cyrillic, ISO_5427:1981, ISO_5428:1980, GB_1988-80, GB_2312-80, NS_4551-1, NS_4551-2, NF_Z_62-010, videotex-suppl, PT2, ES2, ...
Example Default Value
UTF-8
No*
force_graceful integer Example Values
1, 0
Example Default Value
0
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: autoRestart
Added in version 4.7.0-339
Description Set the web server auto-restart status.
Input Parameters
Name Type Notes Required?
apache_autorestart integer Example Values
1, 0
Example Default Value
0
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: disable
Added in version 4.8.0-393
Description  Http disable Apache module action.
Input Parameters
Name Type Notes Required?
name struct (string) Example Values
foo_module, auth_basic_module, auth_digest_module, authn_file_module, authn_alias_module, authn_anon_module, authn_dbm_module, authn_default_module, authz_host_module, authz_user_module, authz_owner_module, authz_groupfile_module, authz_dbm_module, authz_default_module, ldap_module, authnz_ldap_module, include_module, log_config_module, logio_module, env_module, ext_filter_module, mime_magic_module, expires_module, deflate_module, headers_module, usertrack_module, setenvif_module, mime_module, dav_module, status_module, autoindex_module, info_module, dav_fs_module, vhost_alias_module, negotiation_module, dir_module, actions_module, speling_module, userdir_module, alias_module, substitute_module, rewrite_module, proxy_module, proxy_balancer_module, proxy_ftp_module, proxy_http_module, proxy_ajp_module, proxy_connect_module, cache_module, suexec_module, ...
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: enable
Added in version 4.8.0-393
Description  Http enable Apache module action.
Input Parameters
Name Type Notes Required?
name struct (string) Example Values
foo_module, auth_basic_module, auth_digest_module, authn_file_module, authn_alias_module, authn_anon_module, authn_dbm_module, authn_default_module, authz_host_module, authz_user_module, authz_owner_module, authz_groupfile_module, authz_dbm_module, authz_default_module, ldap_module, authnz_ldap_module, include_module, log_config_module, logio_module, env_module, ext_filter_module, mime_magic_module, expires_module, deflate_module, headers_module, usertrack_module, setenvif_module, mime_module, dav_module, status_module, autoindex_module, info_module, dav_fs_module, vhost_alias_module, negotiation_module, dir_module, actions_module, speling_module, userdir_module, alias_module, substitute_module, rewrite_module, proxy_module, proxy_balancer_module, proxy_ftp_module, proxy_http_module, proxy_ajp_module, proxy_connect_module, cache_module, suexec_module, ...
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: enableMultiplePhp
Added in version 6.0.0-1316
Description Enable the Multiple PHP feature.
Action: isRunning
Added in version 4.7.0-339
Description Checks if the service is running or not.
Sample output
array (
’status’ => 0,
’payload’ => true,
)
Action: isRunningOnNode
Added in version 4.7.0-339
Description Checks if the service is running on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: listGeneralName
Added in version 4.7.0-339
Description Lists the "normal" name - ie "web server" instead of "httpd".
Sample output
array (
’status’ => 0,
’payload’ => ’##LG_APACHE##’,
)
Action: listModules
Added in version 4.8.0-393
Description List Apache module information.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’name’ => ’actions_module’,
’enabled’ => 1,
),
1 =>
array (
’name’ => ’alias_module’,
’enabled’ => 1,
),
2 =>
array (
’name’ => ’auth_basic_module’,
’enabled’ => 1,
),
),
)
Action: listPhpInstallMode
Added in version 5.0.14-579
Description Get the mode php is running under.
Sample output
array (
’status’ => 0,
’payload’ => ’mod_suphp’,
)
Action: listPortNumbers
Added in version 4.7.0-339
Description Lists a string of the port numbers that this service uses, comma-seperated.
Sample output
array (
’status’ => 0,
’payload’ => ’80, 443’,
)
Action: listPortNumbersArray
Added in version 4.7.0-339
Description Lists array of port numbers and ranges that this service uses.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’80’,
1 => ’443’,
),
)
Action: listRequiredPermissions
Added in version 4.7.0-339
Description Lists an array of permissions required to control the service.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’APACHE’,
),
)
Action: listServiceInfo
Added in version 4.7.0-339
Description Lists the service name, ports, page, and status.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’id’ => ’httpd’,
’name’ => ’##LG_APACHE##’,
’ports’ => ’80, 443’,
’page’ => ’/nodeworx/http’,
’ctrl’ => ’/nodeworx/http’,
’is_running’ => 1,
),
)
Action: listServiceName
Added in version 4.7.0-339
Description Lists the service name - ie "httpd" instead of "web server".
Sample output
array (
’status’ => 0,
’payload’ => ’httpd’,
)
Action: listServicePage
Added in version 4.7.0-339
Description Lists the page that controls the service.
Sample output
array (
’status’ => 0,
’payload’ => ’/nodeworx/http’,
)
Action: multiplePhpOptions
Added in version 6.0.0-1316
Description Update multiple php options.
Input Parameters
Name Type Notes Required?
enabled_php_versions struct (string) Help Entry
Versions available for new SiteWorx accounts. Disabling a version only removes it from the list - it will still be installed, and any domains currently using it will continue.
Example Values
/opt/remi/php54, /opt/remi/php55, /opt/remi/php56, /opt/remi/php70, /opt/remi/php71, /opt/remi/php72
Example Default Value
["\/opt\/remi\/php70","\/opt\/remi\/php71"]
No
default_php_version string Help Entry
This version will be pre-selected when creating new SiteWorx accounts. This controls the default value when using an API call that may not provide this input for creating a new SiteWorx Account.
Example Values
system-php, /opt/remi/php70, /opt/remi/php71
Example Default Value
/opt/remi/php71
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: queryApacheUpdate
Added in version 5.1.0-838
Description Displays the information available to the action "apacheUpdate".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’http_port’ => ’80’,
’https_port’ => ’443’,
’serverlimit’ => ’256’,
’maxclients’ => ’256’,
’startservers’ => ’8’,
’minspareservers’ => ’5’,
’maxspareservers’ => ’20’,
’maxrequestsperchild’ => ’4000’,
’timeout’ => ’60’,
’keepalive’ => ’0’,
’maxkeepaliverequests’ => ’100’,
’keepalivetimeout’ => ’15’,
’adddefaultcharset’ => ’UTF-8’,
’force_graceful’ => ’0’,
),
)
Action: queryAutoRestart
Added in version 5.1.0-838
Description Displays the information available to the action "autoRestart".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’apache_autorestart’ => ’0’,
),
)
Action: queryEditConf
Added in version 5.1.0-838
Description Displays the information available to the action "editConf".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’file’ => ’/etc/httpd/conf/httpd.conf’,
’file_content’ => ’#
# This is the main Apache server configuration file. It contains the
# configuration directives that give the server its instructions.
# See <URL:http://httpd.apache.org/docs/2.2/> for detailed information.
# In particular, see
# <URL:http://httpd.apache.org/docs/2.2/mod/directives.html>
# for a discussion of each configuration directive.
#
#
# Do NOT simply read the instructions in here without understanding
# what they do. They\’re here only as hints or reminders. If you are unsure
# consult the online docs. You have been warned.
#
# The configuration directives are grouped into three basic sections:
# 1. Directives that control the operation of the Apache server process as a
# whole (the \’global environment\’).
# 2. Directives that define the parameters of the \’main\’ or \’default\’ server,
# which responds to requests that aren\’t handled by a virtual host.
# These directives also provide default values for the settings
# of all virtual hosts.
# 3. Settings for virtual hosts, which allow Web requests to be sent to
# different IP addresses or hostnames and have them handled by the
# same Apache server process.
#
# Configuration and logfile names: If the filenames you specify for many
# of the server\’s control files begin with "/" (or "drive:/" for Win32), the
# server will use that explicit path. If the filenames do *not* begin
# with "/", the value of ServerRoot is prepended — so "logs/foo.log"
# with ServerRoot set to "/etc/httpd" will be interpreted by the
# server as "/etc/httpd/logs/foo.log".
#
### Section 1: Global Environment
#
# The directives in this section affect the overall operation of Apache,
# such as the number of concurrent requests it can handle or where it
# can find its configuration files.
#
#
# Don\’t give away too much information about all the subcomponents
# we are running. Comment out this line if you don\’t mind remote sites
# finding out what major optional modules you are running
ServerTokens OS
#
# ServerRoot: The top of the directory tree under which the server\’s
# configuration, error, and log files are kept.
#
# NOTE! If you intend to place this on an NFS (or otherwise network)
# mounted filesystem then please read the LockFile documentation
# (available at <URL:http://httpd.apache.org/docs/2.2/mod/mpm_common.html#lockfile>);
# you will save yourself a lot of trouble.
#
# Do NOT add a slash at the end of the directory path.
#
ServerRoot "/etc/httpd"
#
# PidFile: The file in which the server should record its process
# identification number when it starts. Note the PIDFILE variable in
# /etc/sysconfig/httpd must be set appropriately if this location is
# changed.
#
PidFile run/httpd.pid
#
# Timeout: The number of seconds before receives and sends time out.
#
Timeout 60
#
# KeepAlive: Whether or not to allow persistent connections (more than
# one request per connection). Set to "Off" to deactivate.
#
KeepAlive off
#
# MaxKeepAliveRequests: The maximum number of requests to allow
# during a persistent connection. Set to 0 to allow an unlimited amount.
# We recommend you leave this number high, for maximum performance.
#
MaxKeepAliveRequests 100
#
# KeepAliveTimeout: Number of seconds to wait for the next request from the
# same client on the same connection.
#
KeepAliveTimeout 15
##
## Server-Pool Size Regulation (MPM specific)
##
# prefork MPM
# StartServers: number of server processes to start
# MinSpareServers: minimum number of server processes which are kept spare
# MaxSpareServers: maximum number of server processes which are kept spare
# ServerLimit: maximum value for MaxClients for the lifetime of the server
# MaxClients: maximum number of server processes allowed to start
# MaxRequestsPerChild: maximum number of requests a server process serves
<IfModule prefork.c>
StartServers 8
MinSpareServers 5
MaxSpareServers 20
ServerLimit 256
MaxClients 256
MaxRequestsPerChild 4000
</IfModule>
# worker MPM
# StartServers: initial number of server processes to start
# MaxClients: maximum number of simultaneous client connections
# MinSpareThreads: minimum number of worker threads which are kept spare
# MaxSpareThreads: maximum number of worker threads which are kept spare
# ThreadsPerChild: constant number of worker threads in each server process
# MaxRequestsPerChild: maximum number of requests a server process serves
<IfModule worker.c>
StartServers 4
MaxClients 300
MinSpareThreads 25
MaxSpareThreads 75
ThreadsPerChild 25
MaxRequestsPerChild 0
</IfModule>
#
# Listen: Allows you to bind Apache to specific IP addresses and/or
# ports, in addition to the default. See also the <VirtualHost>
# directive.
#
# Change this to Listen on specific IP addresses as shown below to
# prevent Apache from glomming onto all bound IP addresses (0.0.0.0)
#
#Listen 12.34.56.78:80
Listen 80
#
# Dynamic Shared Object (DSO) Support
#
# To be able to use the functionality of a module which was built as a DSO you
# have to place corresponding ‘LoadModule\’ lines at this location so the
# directives contained in it are actually available _before_ they are used.
# Statically compiled modules (those listed by ‘httpd -l\’) do not need
# to be loaded here.
#
# Example:
# LoadModule foo_module modules/mod_foo.so
#
LoadModule auth_basic_module modules/mod_auth_basic.so
LoadModule auth_digest_module modules/mod_auth_digest.so
LoadModule authn_file_module modules/mod_authn_file.so
LoadModule authn_alias_module modules/mod_authn_alias.so
LoadModule authn_anon_module modules/mod_authn_anon.so
LoadModule authn_dbm_module modules/mod_authn_dbm.so
LoadModule authn_default_module modules/mod_authn_default.so
LoadModule authz_host_module modules/mod_authz_host.so
LoadModule authz_user_module modules/mod_authz_user.so
LoadModule authz_owner_module modules/mod_authz_owner.so
LoadModule authz_groupfile_module modules/mod_authz_groupfile.so
LoadModule authz_dbm_module modules/mod_authz_dbm.so
LoadModule authz_default_module modules/mod_authz_default.so
LoadModule ldap_module modules/mod_ldap.so
LoadModule authnz_ldap_module modules/mod_authnz_ldap.so
LoadModule include_module modules/mod_include.so
LoadModule log_config_module modules/mod_log_config.so
LoadModule logio_module modules/mod_logio.so
LoadModule env_module modules/mod_env.so
LoadModule ext_filter_module modules/mod_ext_filter.so
LoadModule mime_magic_module modules/mod_mime_magic.so
LoadModule expires_module modules/mod_expires.so
LoadModule deflate_module modules/mod_deflate.so
LoadModule headers_module modules/mod_headers.so
LoadModule usertrack_module modules/mod_usertrack.so
LoadModule setenvif_module modules/mod_setenvif.so
LoadModule mime_module modules/mod_mime.so
LoadModule dav_module modules/mod_dav.so
LoadModule status_module modules/mod_status.so
LoadModule autoindex_module modules/mod_autoindex.so
LoadModule info_module modules/mod_info.so
LoadModule dav_fs_module modules/mod_dav_fs.so
LoadModule vhost_alias_module modules/mod_vhost_alias.so
LoadModule negotiation_module modules/mod_negotiation.so
LoadModule dir_module modules/mod_dir.so
LoadModule actions_module modules/mod_actions.so
LoadModule speling_module modules/mod_speling.so
LoadModule userdir_module modules/mod_userdir.so
LoadModule alias_module modules/mod_alias.so
LoadModule substitute_module modules/mod_substitute.so
LoadModule rewrite_module modules/mod_rewrite.so
LoadModule proxy_module modules/mod_proxy.so
LoadModule proxy_balancer_module modules/mod_proxy_balancer.so
LoadModule proxy_ftp_module modules/mod_proxy_ftp.so
LoadModule proxy_http_module modules/mod_proxy_http.so
LoadModule proxy_ajp_module modules/mod_proxy_ajp.so
LoadModule proxy_connect_module modules/mod_proxy_connect.so
LoadModule cache_module modules/mod_cache.so
LoadModule suexec_module modules/mod_suexec.so
LoadModule disk_cache_module modules/mod_disk_cache.so
LoadModule cgi_module modules/mod_cgi.so
LoadModule version_module modules/mod_version.so
#
# The following modules are not loaded by default:
#
#LoadModule asis_module modules/mod_asis.so
#LoadModule authn_dbd_module modules/mod_authn_dbd.so
#LoadModule cern_meta_module modules/mod_cern_meta.so
#LoadModule cgid_module modules/mod_cgid.so
#LoadModule dbd_module modules/mod_dbd.so
#LoadModule dumpio_module modules/mod_dumpio.so
#LoadModule filter_module modules/mod_filter.so
#LoadModule ident_module modules/mod_ident.so
#LoadModule log_forensic_module modules/mod_log_forensic.so
#LoadModule unique_id_module modules/mod_unique_id.so
#
#
# Load config files from the config directory "/etc/httpd/conf.d".
#
Include conf.d/*.conf
#
# ExtendedStatus controls whether Apache will generate "full" status
# information (ExtendedStatus On) or just basic information (ExtendedStatus
# Off) when the "server-status" handler is called. The default is Off.
#
#ExtendedStatus On
#
# If you wish httpd to run as a different user or group, you must run
# httpd as root initially and it will switch.
#
# User/Group: The name (or #number) of the user/group to run httpd as.
# . On SCO (ODT 3) use "User nouser" and "Group nogroup".
# . On HPUX you may not be able to use shared memory as nobody, and the
# suggested workaround is to create a user www and use that user.
# NOTE that some kernels refuse to setgid(Group) or semctl(IPC_SET)
# when the value of (unsigned)Group is above 60000;
# don\’t use Group #-1 on these systems!
#
User apache
Group apache
### Section 2: \’Main\’ server configuration
#
# The directives in this section set up the values used by the \’main\’
# server, which responds to any requests that aren\’t handled by a
# <VirtualHost> definition. These values also provide defaults for
# any <VirtualHost> containers you may define later in the file.
#
# All of these directives may appear inside <VirtualHost> containers,
# in which case these default settings will be overridden for the
# virtual host being defined.
#
#
# ServerAdmin: Your address, where problems with the server should be
# e-mailed. This address appears on some server-generated pages, such
# as error documents. e.g. admin@your-domain.com
#
ServerAdmin root@localhost
#
# ServerName gives the name and port that the server uses to identify itself.
# This can often be determined automatically, but we recommend you specify
# it explicitly to prevent problems during startup.
#
# If this is not set to valid DNS name for your host, server-generated
# redirections will not work. See also the UseCanonicalName directive.
#
# If your host doesn\’t have a registered DNS name, enter its IP address here.
# You will have to access it by its address anyway, and this will make
# redirections work in a sensible way.
#
#ServerName www.example.com:80
#
# UseCanonicalName: Determines how Apache constructs self-referencing
# URLs and the SERVER_NAME and SERVER_PORT variables.
# When set "Off", Apache will use the Hostname and Port supplied
# by the client. When set "On", Apache will use the value of the
# ServerName directive.
#
UseCanonicalName Off
#
# DocumentRoot: The directory out of which you will serve your
# documents. By default, all requests are taken from this directory, but
# symbolic links and aliases may be used to point to other locations.
#
DocumentRoot "/var/www/html"
#
# Each directory to which Apache has access can be configured with respect
# to which services and features are allowed and/or disabled in that
# directory (and its subdirectories).
#
# First, we configure the "default" to be a very restrictive set of
# features.
#
<Directory />
Options FollowSymLinks
AllowOverride All
</Directory>
#
# Note that from this point forward you must specifically allow
# particular features to be enabled - so if something\’s not working as
# you might expect, make sure that you have specifically enabled it
# below.
#
#
# This should be changed to whatever you set DocumentRoot to.
#
<Directory "/var/www/html">
#
# Possible values for the Options directive are "None", "All",
# or any combination of:
# Indexes Includes FollowSymLinks SymLinksifOwnerMatch ExecCGI MultiViews
#
# Note that "MultiViews" must be named *explicitly* — "Options All"
# doesn\’t give it to you.
#
# The Options directive is both complicated and important. Please see
# http://httpd.apache.org/docs/2.2/mod/core.html#options
# for more information.
#
Options Indexes FollowSymLinks
#
# AllowOverride controls what directives may be placed in .htaccess files.
# It can be "All", "None", or any combination of the keywords:
# Options FileInfo AuthConfig Limit
#
AllowOverride None
#
# Controls who can get stuff from this server.
#
Order allow,deny
Allow from all
</Directory>
#
# UserDir: The name of the directory that is appended onto a user\’s home
# directory if a ~user request is received.
#
# The path to the end user account \’public_html\’ directory must be
# accessible to the webserver userid. This usually means that ~userid
# must have permissions of 711, ~userid/public_html must have permissions
# of 755, and documents contained therein must be world-readable.
# Otherwise, the client will only receive a "403 Forbidden" message.
#
# See also: http://httpd.apache.org/docs/misc/FAQ.html#forbidden
#
<IfModule mod_userdir.c>
#
# UserDir is disabled by default since it can confirm the presence
# of a username on the system (depending on home directory
# permissions).
#
#UserDir disabled
#
# To enable requests to /~user/ to serve the user\’s public_html
# directory, remove the "UserDir disabled" line above, and uncomment
# the following line instead:
#
UserDir public_html
</IfModule>
#
# Control access to UserDir directories. The following is an example
# for a site where these directories are restricted to read-only.
#
#<Directory /home/*/public_html>
# AllowOverride FileInfo AuthConfig Limit
# Options MultiViews Indexes SymLinksIfOwnerMatch IncludesNoExec
# <Limit GET POST OPTIONS>
# Order allow,deny
# Allow from all
# </Limit>
# <LimitExcept GET POST OPTIONS>
# Order deny,allow
# Deny from all
# </LimitExcept>
#</Directory>
#
# DirectoryIndex: sets the file that Apache will serve if a directory
# is requested.
#
# The index.html.var file (a type-map) is used to deliver content-
# negotiated documents. The MultiViews Option can be used for the
# same purpose, but it is much slower.
#
DirectoryIndex index.html index.html.var
#
# AccessFileName: The name of the file to look for in each directory
# for additional configuration directives. See also the AllowOverride
# directive.
#
AccessFileName .htaccess
#
# The following lines prevent .htaccess and .htpasswd files from being
# viewed by Web clients.
#
<Files ~ "^\\.ht">
Order allow,deny
Deny from all
Satisfy All
</Files>
#
# TypesConfig describes where the mime.types file (or equivalent) is
# to be found.
#
TypesConfig /etc/mime.types
#
# DefaultType is the default MIME type the server will use for a document
# if it cannot otherwise determine one, such as from filename extensions.
# If your server contains mostly text or HTML documents, "text/plain" is
# a good value. If most of your content is binary, such as applications
# or images, you may want to use "application/octet-stream" instead to
# keep browsers from trying to display binary files as though they are
# text.
#
DefaultType text/plain
#
# The mod_mime_magic module allows the server to use various hints from the
# contents of the file itself to determine its type. The MIMEMagicFile
# directive tells the module where the hint definitions are located.
#
<IfModule mod_mime_magic.c>
# MIMEMagicFile /usr/share/magic.mime
MIMEMagicFile conf/magic
</IfModule>
#
# HostnameLookups: Log the names of clients or just their IP addresses
# e.g., www.apache.org (on) or 204.62.129.132 (off).
# The default is off because it\’d be overall better for the net if people
# had to knowingly turn this feature on, since enabling it means that
# each client request will result in AT LEAST one lookup request to the
# nameserver.
#
HostnameLookups Off
#
# EnableMMAP: Control whether memory-mapping is used to deliver
# files (assuming that the underlying OS supports it).
# The default is on; turn this off if you serve from NFS-mounted
# filesystems. On some systems, turning it off (regardless of
# filesystem) can improve performance; for details, please see
# http://httpd.apache.org/docs/2.2/mod/core.html#enablemmap
#
#EnableMMAP off
#
# EnableSendfile: Control whether the sendfile kernel support is
# used to deliver files (assuming that the OS supports it).
# The default is on; turn this off if you serve from NFS-mounted
# filesystems. Please see
# http://httpd.apache.org/docs/2.2/mod/core.html#enablesendfile
#
#EnableSendfile off
#
# ErrorLog: The location of the error log file.
# If you do not specify an ErrorLog directive within a <VirtualHost>
# container, error messages relating to that virtual host will be
# logged here. If you *do* define an error logfile for a <VirtualHost>
# container, that host\’s errors will be logged there and not here.
#
ErrorLog logs/error_log
#
# LogLevel: Control the number of messages logged to the error_log.
# Possible values include: debug, info, notice, warn, error, crit,
# alert, emerg.
#
LogLevel warn
#
# The following directives define some format nicknames for use with
# a CustomLog directive (see below).
#
LogFormat "%h %l %u %t \\"%r\\" %>s %b \\"%{Referer}i\\" \\"%{User-Agent}i\\"" combined
LogFormat "%h %l %u %t \\"%r\\" %>s %b" common
LogFormat "%{Referer}i -> %U" referer
LogFormat "%{User-agent}i" agent
# "combinedio" includes actual counts of actual bytes received (%I) and sent (%O); this
# requires the mod_logio module to be loaded.
#LogFormat "%h %l %u %t \\"%r\\" %>s %b \\"%{Referer}i\\" \\"%{User-Agent}i\\" %I %O" combinedio
#
# The location and format of the access logfile (Common Logfile Format).
# If you do not define any access logfiles within a <VirtualHost>
# container, they will be logged here. Contrariwise, if you *do*
# define per-<VirtualHost> access logfiles, transactions will be
# logged therein and *not* in this file.
#
#CustomLog logs/access_log common
#
# If you would like to have separate agent and referer logfiles, uncomment
# the following directives.
#
#CustomLog logs/referer_log referer
#CustomLog logs/agent_log agent
#
# For a single logfile with access, agent, and referer information
# (Combined Logfile Format), use the following directive:
#
CustomLog logs/access_log combined
#
# Optionally add a line containing the server version and virtual host
# name to server-generated pages (internal error documents, FTP directory
# listings, mod_status and mod_info output etc., but not CGI generated
# documents or custom error documents).
# Set to "EMail" to also include a mailto: link to the ServerAdmin.
# Set to one of: On | Off | EMail
#
ServerSignature On
#
# Aliases: Add here as many aliases as you need (with no limit). The format is
# Alias fakename realname
#
# Note that if you include a trailing / on fakename then the server will
# require it to be present in the URL. So "/icons" isn\’t aliased in this
# example, only "/icons/". If the fakename is slash-terminated, then the
# realname must also be slash terminated, and if the fakename omits the
# trailing slash, the realname must also omit it.
#
# We include the /icons/ alias for FancyIndexed directory listings. If you
# do not use FancyIndexing, you may comment this out.
#
Alias /icons/ "/var/www/icons/"
<Directory "/var/www/icons">
Options Indexes MultiViews FollowSymLinks
AllowOverride None
Order allow,deny
Allow from all
</Directory>
#
# WebDAV module configuration section.
#
<IfModule mod_dav_fs.c>
# Location of the WebDAV lock database.
DAVLockDB /var/lib/dav/lockdb
</IfModule>
#
# ScriptAlias: This controls which directories contain server scripts.
# ScriptAliases are essentially the same as Aliases, except that
# documents in the realname directory are treated as applications and
# run by the server when requested rather than as documents sent to the client.
# The same rules about trailing "/" apply to ScriptAlias directives as to
# Alias.
#
ScriptAlias /cgi-bin/ "/var/www/cgi-bin/"
#
# "/var/www/cgi-bin" should be changed to whatever your ScriptAliased
# CGI directory exists, if you have that configured.
#
<Directory "/var/www/cgi-bin">
AllowOverride None
Options None
Order allow,deny
Allow from all
</Directory>
#
# Redirect allows you to tell clients about documents which used to exist in
# your server\’s namespace, but do not anymore. This allows you to tell the
# clients where to look for the relocated document.
# Example:
# Redirect permanent /foo http://www.example.com/bar
#
# Directives controlling the display of server-generated directory listings.
#
#
# IndexOptions: Controls the appearance of server-generated directory
# listings.
#
IndexOptions FancyIndexing VersionSort NameWidth=* HTMLTable Charset=UTF-8
#
# AddIcon* directives tell the server which icon to show for different
# files or filename extensions. These are only displayed for
# FancyIndexed directories.
#
AddIconByEncoding (CMP,/icons/compressed.gif) x-compress x-gzip
AddIconByType (TXT,/icons/text.gif) text/*
AddIconByType (IMG,/icons/image2.gif) image/*
AddIconByType (SND,/icons/sound2.gif) audio/*
AddIconByType (VID,/icons/movie.gif) video/*
AddIcon /icons/binary.gif .bin .exe
AddIcon /icons/binhex.gif .hqx
AddIcon /icons/tar.gif .tar
AddIcon /icons/world2.gif .wrl .wrl.gz .vrml .vrm .iv
AddIcon /icons/compressed.gif .Z .z .tgz .gz .zip
AddIcon /icons/a.gif .ps .ai .eps
AddIcon /icons/layout.gif .html .shtml .htm .pdf
AddIcon /icons/text.gif .txt
AddIcon /icons/c.gif .c
AddIcon /icons/p.gif .pl .py
AddIcon /icons/f.gif .for
AddIcon /icons/dvi.gif .dvi
AddIcon /icons/uuencoded.gif .uu
AddIcon /icons/script.gif .conf .sh .shar .csh .ksh .tcl
AddIcon /icons/tex.gif .tex
AddIcon /icons/bomb.gif core
AddIcon /icons/back.gif ..
AddIcon /icons/hand.right.gif README
AddIcon /icons/folder.gif ^^DIRECTORY^^
AddIcon /icons/blank.gif ^^BLANKICON^^
#
# DefaultIcon is which icon to show for files which do not have an icon
# explicitly set.
#
DefaultIcon /icons/unknown.gif
#
# AddDescription allows you to place a short description after a file in
# server-generated indexes. These are only displayed for FancyIndexed
# directories.
# Format: AddDescription "description" filename
#
#AddDescription "GZIP compressed document" .gz
#AddDescription "tar archive" .tar
#AddDescription "GZIP compressed tar archive" .tgz
#
# ReadmeName is the name of the README file the server will look for by
# default, and append to directory listings.
#
# HeaderName is the name of a file which should be prepended to
# directory indexes.
ReadmeName README.html
HeaderName HEADER.html
#
# IndexIgnore is a set of filenames which directory indexing should ignore
# and not include in the listing. Shell-style wildcarding is permitted.
#
IndexIgnore .??* *~ *# HEADER* README* RCS CVS *,v *,t
#
# DefaultLanguage and AddLanguage allows you to specify the language of
# a document. You can then use content negotiation to give a browser a
# file in a language the user can understand.
#
# Specify a default language. This means that all data
# going out without a specific language tag (see below) will
# be marked with this one. You probably do NOT want to set
# this unless you are sure it is correct for all cases.
#
# * It is generally better to not mark a page as
# * being a certain language than marking it with the wrong
# * language!
#
# DefaultLanguage nl
#
# Note 1: The suffix does not have to be the same as the language
# keyword — those with documents in Polish (whose net-standard
# language code is pl) may wish to use "AddLanguage pl .po" to
# avoid the ambiguity with the common suffix for perl scripts.
#
# Note 2: The example entries below illustrate that in some cases
# the two character \’Language\’ abbreviation is not identical to
# the two character \’Country\’ code for its country,
# E.g. \’Danmark/dk\’ versus \’Danish/da\’.
#
# Note 3: In the case of \’ltz\’ we violate the RFC by using a three char
# specifier. There is \’work in progress\’ to fix this and get
# the reference data for rfc1766 cleaned up.
#
# Catalan (ca) - Croatian (hr) - Czech (cs) - Danish (da) - Dutch (nl)
# English (en) - Esperanto (eo) - Estonian (et) - French (fr) - German (de)
# Greek-Modern (el) - Hebrew (he) - Italian (it) - Japanese (ja)
# Korean (ko) - Luxembourgeois* (ltz) - Norwegian Nynorsk (nn)
# Norwegian (no) - Polish (pl) - Portugese (pt)
# Brazilian Portuguese (pt-BR) - Russian (ru) - Swedish (sv)
# Simplified Chinese (zh-CN) - Spanish (es) - Traditional Chinese (zh-TW)
#
AddLanguage ca .ca
AddLanguage cs .cz .cs
AddLanguage da .dk
AddLanguage de .de
AddLanguage el .el
AddLanguage en .en
AddLanguage eo .eo
AddLanguage es .es
AddLanguage et .et
AddLanguage fr .fr
AddLanguage he .he
AddLanguage hr .hr
AddLanguage it .it
AddLanguage ja .ja
AddLanguage ko .ko
AddLanguage ltz .ltz
AddLanguage nl .nl
AddLanguage nn .nn
AddLanguage no .no
AddLanguage pl .po
AddLanguage pt .pt
AddLanguage pt-BR .pt-br
AddLanguage ru .ru
AddLanguage sv .sv
AddLanguage zh-CN .zh-cn
AddLanguage zh-TW .zh-tw
#
# LanguagePriority allows you to give precedence to some languages
# in case of a tie during content negotiation.
#
# Just list the languages in decreasing order of preference. We have
# more or less alphabetized them here. You probably want to change this.
#
LanguagePriority en ca cs da de el eo es et fr he hr it ja ko ltz nl nn no pl pt pt-BR ru sv zh-CN zh-TW
#
# ForceLanguagePriority allows you to serve a result page rather than
# MULTIPLE CHOICES (Prefer) [in case of a tie] or NOT ACCEPTABLE (Fallback)
# [in case no accepted languages matched the available variants]
#
ForceLanguagePriority Prefer Fallback
#
# Specify a default charset for all content served; this enables
# interpretation of all content as UTF-8 by default. To use the
# default browser choice (ISO-8859-1), or to allow the META tags
# in HTML content to override this choice, comment out this
# directive:
#
AddDefaultCharset UTF-8
#
# AddType allows you to add to or override the MIME configuration
# file mime.types for specific file types.
#
#AddType application/x-tar .tgz
#
# AddEncoding allows you to have certain browsers uncompress
# information on the fly. Note: Not all browsers support this.
# Despite the name similarity, the following Add* directives have nothing
# to do with the FancyIndexing customization directives above.
#
#AddEncoding x-compress .Z
#AddEncoding x-gzip .gz .tgz
# If the AddEncoding directives above are commented-out, then you
# probably should define those extensions to indicate media types:
#
AddType application/x-compress .Z
AddType application/x-gzip .gz .tgz
#
# MIME-types for downloading Certificates and CRLs
#
AddType application/x-x509-ca-cert .crt
AddType application/x-pkcs7-crl .crl
#
# AddHandler allows you to map certain file extensions to "handlers":
# actions unrelated to filetype. These can be either built into the server
# or added with the Action directive (see below)
#
# To use CGI scripts outside of ScriptAliased directories:
# (You will also need to add "ExecCGI" to the "Options" directive.)
#
#AddHandler cgi-script .cgi
#
# For files that include their own HTTP headers:
#
#AddHandler send-as-is asis
#
# For type maps (negotiated resources):
# (This is enabled by default to allow the Apache "It Worked" page
# to be distributed in multiple languages.)
#
AddHandler type-map var
#
# Filters allow you to process content before it is sent to the client.
#
# To parse .shtml files for server-side includes (SSI):
# (You will also need to add "Includes" to the "Options" directive.)
#
AddType text/html .shtml
AddOutputFilter INCLUDES .shtml
#
# Action lets you define media types that will execute a script whenever
# a matching file is called. This eliminates the need for repeated URL
# pathnames for oft-used CGI file processors.
# Format: Action media/type /cgi-script/location
# Format: Action handler-name /cgi-script/location
#
#
# Customizable error responses come in three flavors:
# 1) plain text 2) local redirects 3) external redirects
#
# Some examples:
#ErrorDocument 500 "The server made a boo boo."
#ErrorDocument 404 /missing.html
#ErrorDocument 404 "/cgi-bin/missing_handler.pl"
#ErrorDocument 402 http://www.example.com/subscription_info.html
#
#
# Putting this all together, we can internationalize error responses.
#
# We use Alias to redirect any /error/HTTP_<error>.html.var response to
# our collection of by-error message multi-language collections. We use
# includes to substitute the appropriate text.
#
# You can modify the messages\’ appearance without changing any of the
# default HTTP_<error>.html.var files by adding the line:
#
# Alias /error/include/ "/your/include/path/"
#
# which allows you to create your own set of files by starting with the
# /var/www/error/include/ files and
# copying them to /your/include/path/, even on a per-VirtualHost basis.
#
Alias /error/ "/var/www/error/"
<IfModule mod_negotiation.c>
<IfModule mod_include.c>
<Directory "/var/www/error">
AllowOverride None
Options IncludesNoExec
AddOutputFilter Includes html
AddHandler type-map var
Order allow,deny
Allow from all
LanguagePriority en es de fr
ForceLanguagePriority Prefer Fallback
</Directory>
# ErrorDocument 400 /error/HTTP_BAD_REQUEST.html.var
# ErrorDocument 401 /error/HTTP_UNAUTHORIZED.html.var
# ErrorDocument 403 /error/HTTP_FORBIDDEN.html.var
# ErrorDocument 404 /error/HTTP_NOT_FOUND.html.var
# ErrorDocument 405 /error/HTTP_METHOD_NOT_ALLOWED.html.var
# ErrorDocument 408 /error/HTTP_REQUEST_TIME_OUT.html.var
# ErrorDocument 410 /error/HTTP_GONE.html.var
# ErrorDocument 411 /error/HTTP_LENGTH_REQUIRED.html.var
# ErrorDocument 412 /error/HTTP_PRECONDITION_FAILED.html.var
# ErrorDocument 413 /error/HTTP_REQUEST_ENTITY_TOO_LARGE.html.var
# ErrorDocument 414 /error/HTTP_REQUEST_URI_TOO_LARGE.html.var
# ErrorDocument 415 /error/HTTP_UNSUPPORTED_MEDIA_TYPE.html.var
# ErrorDocument 500 /error/HTTP_INTERNAL_SERVER_ERROR.html.var
# ErrorDocument 501 /error/HTTP_NOT_IMPLEMENTED.html.var
# ErrorDocument 502 /error/HTTP_BAD_GATEWAY.html.var
# ErrorDocument 503 /error/HTTP_SERVICE_UNAVAILABLE.html.var
# ErrorDocument 506 /error/HTTP_VARIANT_ALSO_VARIES.html.var
</IfModule>
</IfModule>
#
# The following directives modify normal HTTP response behavior to
# handle known problems with browser implementations.
#
BrowserMatch "Mozilla/2" nokeepalive
BrowserMatch "MSIE 4\\.0b2;" nokeepalive downgrade-1.0 force-response-1.0
BrowserMatch "RealPlayer 4\\.0" force-response-1.0
BrowserMatch "Java/1\\.0" force-response-1.0
BrowserMatch "JDK/1\\.0" force-response-1.0
#
# The following directive disables redirects on non-GET requests for
# a directory that does not include the trailing slash. This fixes a
# problem with Microsoft WebFolders which does not appropriately handle
# redirects for folders with DAV methods.
# Same deal with Apple\’s DAV filesystem and Gnome VFS support for DAV.
#
BrowserMatch "Microsoft Data Access Internet Publishing Provider" redirect-carefully
BrowserMatch "MS FrontPage" redirect-carefully
BrowserMatch "^WebDrive" redirect-carefully
BrowserMatch "^WebDAVFS/1.[0123]" redirect-carefully
BrowserMatch "^gnome-vfs/1.0" redirect-carefully
BrowserMatch "^XML Spy" redirect-carefully
BrowserMatch "^Dreamweaver-WebDAV-SCM1" redirect-carefully
#
# Allow server status reports generated by mod_status,
# with the URL of http://servername/server-status
# Change the ".example.com" to match your domain to enable.
#
#<Location /server-status>
# SetHandler server-status
# Order deny,allow
# Deny from all
# Allow from .example.com
#</Location>
#
# Allow remote server configuration reports, with the URL of
# http://servername/server-info (requires that mod_info.c be loaded).
# Change the ".example.com" to match your domain to enable.
#
#<Location /server-info>
# SetHandler server-info
# Order deny,allow
# Deny from all
# Allow from .example.com
#</Location>
#
# Proxy Server directives. Uncomment the following lines to
# enable the proxy server:
#
#<IfModule mod_proxy.c>
#ProxyRequests On
#
#<Proxy *>
# Order deny,allow
# Deny from all
# Allow from .example.com
#</Proxy>
#
# Enable/disable the handling of HTTP/1.1 "Via:" headers.
# ("Full" adds the server version; "Block" removes all outgoing Via: headers)
# Set to one of: Off | On | Full | Block
#
#ProxyVia On
#
# To enable a cache of proxied content, uncomment the following lines.
# See http://httpd.apache.org/docs/2.2/mod/mod_cache.html for more details.
#
#<IfModule mod_disk_cache.c>
# CacheEnable disk /
# CacheRoot "/var/cache/mod_proxy"
#</IfModule>
#
#</IfModule>
# End of proxy directives.
### Section 3: Virtual Hosts
#
# VirtualHost: If you want to maintain multiple domains/hostnames on your
# machine you can setup VirtualHost containers for them. Most configurations
# use only name-based virtual hosts so the server doesn\’t need to worry about
# IP addresses. This is indicated by the asterisks in the directives below.
#
# Please see the documentation at
# <URL:http://httpd.apache.org/docs/2.2/vhosts/>
# for further details before you try to setup virtual hosts.
#
# You may use the command line option \’-S\’ to verify your virtual host
# configuration.
#
# Use name-based virtual hosting.
#
#NameVirtualHost *:80
#
# NOTE: NameVirtualHost cannot be used without a port specifier
# (e.g. :80) if mod_ssl is being used, due to the nature of the
# SSL protocol.
#
#
# VirtualHost example:
# Almost any Apache directive may go into a VirtualHost container.
# The first VirtualHost section is used for requests without a known
# server name.
#
#<VirtualHost *:80>
# ServerAdmin webmaster@dummy-host.example.com
# DocumentRoot /www/docs/dummy-host.example.com
# ServerName dummy-host.example.com
# ErrorLog logs/dummy-host.example.com-error_log
# CustomLog logs/dummy-host.example.com-access_log common
#</VirtualHost>
’,
),
)
Action: queryUpdatePhpMode
Added in version 5.1.0-838
Description Displays the information available to the action "updatePhpMode".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’version’ => ’5.3.3 (base)’,
’php_mode’ => ’mod_suphp’,
),
)
Action: remove
Added in version 4.8.0-393
Description  Http remove Apache module action.
Input Parameters
Name Type Notes Required?
name struct (string) Example Values
foo_module, auth_basic_module, auth_digest_module, authn_file_module, authn_alias_module, authn_anon_module, authn_dbm_module, authn_default_module, authz_host_module, authz_user_module, authz_owner_module, authz_groupfile_module, authz_dbm_module, authz_default_module, ldap_module, authnz_ldap_module, include_module, log_config_module, logio_module, env_module, ext_filter_module, mime_magic_module, expires_module, deflate_module, headers_module, usertrack_module, setenvif_module, mime_module, dav_module, status_module, autoindex_module, info_module, dav_fs_module, vhost_alias_module, negotiation_module, dir_module, actions_module, speling_module, userdir_module, alias_module, substitute_module, rewrite_module, proxy_module, proxy_balancer_module, proxy_ftp_module, proxy_http_module, proxy_ajp_module, proxy_connect_module, cache_module, suexec_module, ...
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: resetPhpFpmFiles
Added in version 6.0.0-1316
Description Delete and recreate InterWorx fpm files.
Action: restart
Added in version 4.7.0-339
Description Restarts the service.
Input Parameters
Name Type Notes Required?
cond integer Help Entry
Restart the service, only if it is currently running.
Example Values
1, 0
Example Default Value
0
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: restartOnNode
Added in version 4.7.0-339
Description Restarts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: start
Added in version 4.7.0-339
Description Starts the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: startOnBoot
Added in version 4.7.0-339
Description Set the web server start-on-boot status.
Input Parameters
Name Type Notes Required?
startonboot integer Example Values
1, 0
Example Default Value
1
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: startOnNode
Added in version 4.7.0-339
Description Starts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: stop
Added in version 4.7.0-339
Description Stops the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: stopOnNode
Added in version 4.7.0-339
Description Stops the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: syncAllConfigFiles
Added in version 5.0.14-579
Description Syncronizes all config files.
Action: syncConfigFiles
Added in version 5.0.14-579
Description Synchronize the config files for a SiteWorx Account.
Input Parameters
Name Type Notes Required?
domain string Example Values
example.com, secondary.com
Yes
Action: syncRedirects
Added in version 5.0.14-579
Description Write out changes to redirect pointer domain configuration.
Action: updatePhpMode
Added in version 4.7.0-339
Description Set php installation mode.
Input Parameters
Name Type Notes Required?
php_mode string Help Entry
The method the web service uses to connect to PHP. InterWorx strongly recommends avoiding mod_php, which executes all sites as the Apache user and presents a security risk.
Example Values
mod_suphp, php-fpm
Example Default Value
mod_suphp
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: updateRrd
Added in version 4.7.0-339
Description Show or hide the web server connections RRD graph in the web interface.
Input Parameters
Name Type Notes Required?
rrd integer Help Entry
Use the dropdown to turn the web server activity graph on or off.
Example Values
1, 0
Example Default Value
0
No*
* indicates that it’s actually required, but probably already has a valid default value

19 Controller: /nodeworx/index

Action: getSession
Added in version 4.7.0-339
Description Gets the session id.
Sample output
array (
’status’ => 0,
’payload’ => ’4274be8c8e0e553bd1577ef69610a93b’,
)
Action: getWebsetupStatus
Added in version 5.0.14-579
Description Get Web Setup status.

20 Controller: /nodeworx/ip

Required Permissions "IPS"
Action: activate
Added in version 5.0.14-579
Description Activate an IP.
Input Parameters
Name Type Notes Required?
ip struct (string) Example Values
10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101, 2001:db8::d:1102
Yes
Action: add
Added in version 4.7.0-339
Description Add an ip address range.
Input Parameters
Name Type Notes Required?
ip_start string Description
IPv6 or IPv4
Yes
ip_end string Description
IPv6 or IPv4
Yes
netmask string Yes
device string Example Values
eth0, lo
Yes
type string Example Values
static, shared
Yes
reseller integer Example Values
1, 0
Yes
vip integer Example Values
1, 0
Yes
Action: delete
Added in version 5.0.14-579
Description Deletes an IP from the system.
Input Parameters
Name Type Notes Required?
ip string Help Entry
####
Example Values
10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101, 2001:db8::d:1102
Yes
confirm_action struct (integer) Example Values
1
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: edit
Added in version 5.0.14-579
Description Edit an IP Address.
Input Parameters
Name Type Notes Required?
ip string Help Entry
####
Example Values
10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101, 2001:db8::d:1102
Yes
netmask string Example Default Value
255.255.0.0
No*
device string Example Values
eth0, lo
Example Default Value
eth0
No*
external_ip string No
is_static integer Example Values
0, 1
Example Default Value
0
No*
is_reseller integer Example Values
1, 0
Example Default Value
0
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: forceRemoveVipStatus
Added in version 5.1.51-1304
Description Remove VIP Status (internal use).
Input Parameters
Name Type Notes Required?
ip string Help Entry
####
Example Values
10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101, 2001:db8::d:1102
Yes
Action: import
Added in version 5.0.14-579
Description Imports a system IP to InterWorx.
Input Parameters
Name Type Notes Required?
ip struct (string) Example Values
10.1.15.200, fe80::fcb5:65ff:fe2a:a05
Yes
Action: listIpAddresses
Added in version 5.0.14-579
Description List ipv4 addresses on the system.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’ipaddr’ => ’10.1.15.200’,
’ext_ipaddr’ => ’10.1.15.200’,
’device’ => ’eth0’,
’type’ => NULL,
’reseller’ => 0,
’vip’ => 0,
’sys_aware’ => 1,
’iworx_aware’ => 0,
’iworx_managed’ => 0,
’resellers’ => ’’,
’domains’ => ’’,
’assigned_to_reseller’ => NULL,
’ssl_domain’ => NULL,
’is_internal’ => NULL,
’siteworx_count’ => NULL,
’version’ => ’4’,
’netmask’ => ’255.255.0.0’,
),
1 =>
array (
’ipaddr’ => ’2001:db8::d:1101’,
’ext_ipaddr’ => ’2001:db8::d:1101’,
’device’ => ’eth0’,
’type’ => ’shared’,
’reseller’ => 1,
’vip’ => 1,
’sys_aware’ => 1,
’iworx_aware’ => 1,
’iworx_managed’ => 0,
’resellers’ => ’’,
’domains’ => ’’,
’assigned_to_reseller’ => false,
’ssl_domain’ => false,
’is_internal’ => false,
’siteworx_count’ => 0,
’version’ => ’6’,
’netmask’ => ’64’,
),
2 =>
array (
’ipaddr’ => ’2001:db8::d:1102’,
’ext_ipaddr’ => ’2001:db8::d:1102’,
’device’ => ’eth0’,
’type’ => ’quorum’,
’reseller’ => 1,
’vip’ => 0,
’sys_aware’ => 1,
’iworx_aware’ => 1,
’iworx_managed’ => 0,
’resellers’ => ’’,
’domains’ => ’’,
’assigned_to_reseller’ => false,
’ssl_domain’ => false,
’is_internal’ => false,
’siteworx_count’ => 0,
’version’ => ’6’,
’netmask’ => ’64’,
),
),
)
Action: queryDomains
Added in version 5.0.14-579
Description Show domains on an IP address.
Input Parameters
Name Type Notes Required?
ip string Example Values
10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101, 2001:db8::d:1102
Yes
Action: queryEdit
Added in version 5.1.0-838
Description Displays the information available to the action "edit".
Input Parameters
Name Type Notes Required?
ip string Help Entry
####
Example Values
10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101, 2001:db8::d:1102
Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’ip_copy’ => ’10.1.15.100’,
’netmask’ => ’255.255.0.0’,
’device’ => ’eth0’,
’external_ip’ => ’’,
’is_static’ => ’0’,
’is_reseller’ => ’0’,
’is_vip’ => ’1’,
’is_locked’ => ’0’,
’ip’ => ’10.1.15.100’,
),
)
Action: queryIPv6Status
Added in version 5.0.14-579
Description Shows the current IPv6 status.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’section’ => ’##LG_IPV6_STATUS##’,
’option’ => ’##LG_IPV6_CAPABLE##’,
’qh’ => ’<span class=\’iw-qh\’><span class=\’quickhelp\’ data-qh=\’Checks to see if the Linux kernel has been compiled with IPv6 support\’>?</span></span>’,
’value’ => ’##LG_YES##’,
),
1 =>
array (
’section’ => ’##LG_IPV6_STATUS##’,
’option’ => ’##LG_IPV6_ENABLED##’,
’qh’ => ’<span class=\’iw-qh\’><span class=\’quickhelp\’ data-qh=\’IPv6 may be disabled in InterWorx. This indicator shows the status as far as InterWorx is concerned.\’>?</span></span>’,
’value’ => ’##LG_YES##’,
),
2 =>
array (
’section’ => ’##LG_IPV6_STATUS##’,
’option’ => ’##LG_IPV6_CLUSTERING##’,
’qh’ => ’<span class=\’iw-qh\’><span class=\’quickhelp\’ data-qh=\’This indicator shows whether the system is running the correct versions of ipvsadm and the Linux kernel to load-balance IPv6 traffic\’>?</span></span>’,
’value’ => ’##LG_YES##’,
),
),
)
Action: queryResellers
Added in version 5.0.14-579
Description Shows resellers that have access to an IP address.
Input Parameters
Name Type Notes Required?
ip string Example Values
10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101, 2001:db8::d:1102
Yes
Action: querySiteworxAccounts
Added in version 5.0.14-579
Description Show siteworx accounts that have access to an IP address.
Input Parameters
Name Type Notes Required?
ip string Example Values
10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101, 2001:db8::d:1102
Yes
Action: syncIpData
Added in version 5.0.14-579
Description Syncronizes IP data from the CM to the Node.
Input Parameters
Name Type Notes Required?
ip string Example Values
10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101, 2001:db8::d:1102
Yes

21 Controller: /nodeworx/ip/sites

Required Permissions "IPS"
Action: defaultSitesStatus
Added in version 4.8.0-393
Description Change the status of the Default Sites feature.
Input Parameters
Name Type Notes Required?
status 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: disableDefaultSites
Added in version 4.8.0-393
Description Disables default sites feature.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: enableDefaultSites
Added in version 4.8.0-393
Description Enables default sites feature.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: listIpDefaultSites
Added in version 4.8.0-393
Description List the sites IPs redirect to when requested like http://ip.ad.dr.es/.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’ip’ => ’10.1.15.100’,
’location’ => ’/var/www/html’,
’domains’ => ’example.com, secondary.com’,
),
1 =>
array (
’ip’ => ’10.1.15.101’,
’location’ => ’/var/www/html’,
’domains’ => ’’,
),
2 =>
array (
’ip’ => ’10.1.15.102’,
’location’ => ’/var/www/html’,
’domains’ => ’’,
),
),
)
Action: queryDefaultSitesStatus
Added in version 5.1.0-838
Description Displays the information available to the action "defaultSitesStatus".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’status’ => ’1’,
),
)
Action: updateIpDefaultSites
Added in version 4.8.0-393
Description Change the locations IPs redirect to when requested like http://ip.ad.dr.es/.
Input Parameters
Name Type Notes Required?
ip struct (string) Help Entry
####
Example Values
10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104, 2001:db8::d:1101, 2001:db8::d:1102
Yes
site string Description
Leave blank for default
Help Entry
This is the web location that the browser will be redirected to if they navigate directly to the IP address in their browser, i.e. http://203.0.113.22/. If you chose a blank value, the request will display a "default" splash page. The files for the default splash page are at /var/www/html/. You can choose one of the domains on that IP address, or any other domain you prefer.
No

22 Controller: /nodeworx/ipv6

Required Permissions "IPS"
Action: addPool
Added in version 5.0.14-579
Description Add a new IPv6 Pool.
Input Parameters
Name Type Notes Required?
nickname string Yes
ipv6_with_cidr string Description
CIDR Notation
Help Entry
Use Classless Inter Domain Routing (CIDR) notation to designate a block of IPs to use in the pool - for example, 2001:db8::/32. The CIDR is used to define the size of the pool to pull from, not the netmask of the resulting IPs.
Yes
cidr integer Description
CIDR Notation
Help Entry
Netmask to use with IPs pulled from the pool.
Example Default Value
128
No*
subpool_size integer Description
CIDR Notation
Help Entry
This value determines the size of smaller, dedicated Subpools that will be generated from the parent. Each Subpool will be dedicated to a single SiteWorx account, allowing easier management of IPv6 networking. To disable the feature, leave the Subpool Size the same as the CIDR of the Pool itself.
Yes
device string Example Values
eth0, lo
Yes
gateway string Yes
distribution_policy string Help Entry
The Distribution Policy controls how IPv6 Addresses are assigned from the pool.
Example Values
random, sequential
Example Default Value
sequential
No*
reseller_id integer No*
* indicates that it’s actually required, but probably already has a valid default value
Action: addReservation
Added in version 5.0.14-579
Description Add a reserved IP or range.
Input Parameters
Name Type Notes Required?
range_start string Description
IPv6 Address
Yes
range_end string Description
IPv6 Address
Yes
note string No
Action: deletePool
Added in version 5.0.14-579
Description Delete an unused IPv6 Pool.
Input Parameters
Name Type Notes Required?
pool struct (string) Example Values
dead::/64, dead::/24
Yes
Action: deleteReservation
Added in version 5.0.14-579
Description Delete a reserved IP or range.
Input Parameters
Name Type Notes Required?
id struct (integer) Yes
Action: editPool
Added in version 5.0.14-579
Description Edit an IPv6 Pool.
Input Parameters
Name Type Notes Required?
pool string Example Values
dead::/64, dead::/24
Yes
nickname string Example Default Value
##LG_IPV6_SUBPOOL_OF_X|Pool Test##
No*
cidr integer Description
CIDR Notation
Help Entry
Netmask to use with IPs pulled from the pool.
Example Default Value
128
No*
device string Example Values
eth0, lo
Example Default Value
eth0
No*
gateway string Example Default Value
dead::beef/24
No*
reseller_id integer No*
* indicates that it’s actually required, but probably already has a valid default value
Action: editReservation
Added in version 5.0.14-579
Description Edit a reserved IP or range.
Input Parameters
Name Type Notes Required?
id integer Yes
range_start string Description
IPv6 Address
Example Default Value
dead::beef/24
No*
range_end string Description
IPv6 Address
Example Default Value
dead::beef/24
No*
note string Example Default Value
##LG_IPV6_RESERVED_GATEWAY|Pool Test##
No
* indicates that it’s actually required, but probably already has a valid default value
Action: listPools
Added in version 5.0.14-579
Description Lists information about configured IPv6 Pools.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’cidr_format’ => ’dead::/64’,
’nickname’ => ’##LG_IPV6_SUBPOOL_OF_X|Pool Test##’,
’range_start’ => ’295986882420777848964380943247191572480’,
’range_end’ => ’295986882420777848982827687320901124095’,
’distribution_policy’ => ’sequential’,
’dedicated_reseller_id’ => ’0’,
’device’ => ’eth0’,
’netmask_cidr’ => ’128’,
’dedicated_siteworx_id’ => ’0’,
’reseller_count’ => ’0’,
’used_by’ => NULL,
’parent_id’ => ’2’,
),
1 =>
array (
’cidr_format’ => ’dead::/24’,
’nickname’ => ’Pool Test’,
’range_start’ => ’295986882420777848964380943247191572480’,
’range_end’ => ’295986902703187452616051367194442858495’,
’distribution_policy’ => ’sequential’,
’dedicated_reseller_id’ => ’0’,
’device’ => ’eth0’,
’netmask_cidr’ => ’128’,
’dedicated_siteworx_id’ => ’0’,
’reseller_count’ => ’0’,
’used_by’ => NULL,
’parent_id’ => ’0’,
),
),
)
Action: listReserved
Added in version 5.0.14-579
Description Lists information reserved IPv6 addresses.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’id’ => ’1’,
’range_start’ => ’::1’,
’range_end’ => ’::1’,
’note’ => ’##LG_IPV6_RESERVED_LOOPBACK##’,
),
1 =>
array (
’id’ => ’3’,
’range_start’ => ’dead::beef/24’,
’range_end’ => ’dead::beef/24’,
’note’ => ’##LG_IPV6_RESERVED_GATEWAY|Pool Test##’,
),
),
)
Action: queryEditPool
Added in version 5.1.0-838
Description Displays the information available to the action "editPool".
Input Parameters
Name Type Notes Required?
pool string Example Values
dead::/64, dead::/24
Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’nickname’ => ’##LG_IPV6_SUBPOOL_OF_X|Pool Test##’,
’ipv6_with_cidr’ => ’dead::/64’,
’cidr’ => ’128’,
’subpool_size’ => ’64’,
’device’ => ’eth0’,
’gateway’ => ’dead::beef/24’,
’distribution_policy’ => ’sequential’,
’reseller_id’ => ’0’,
’pool’ => ’dead::/64’,
),
)
Action: queryEditReservation
Added in version 5.1.0-838
Description Displays the information available to the action "editReservation".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’range_start’ => ’dead::beef/24’,
’range_end’ => ’dead::beef/24’,
’note’ => ’##LG_IPV6_RESERVED_GATEWAY|Pool Test##’,
’id’ => ’3’,
),
)

23 Controller: /nodeworx/lang

Required Permissions "LANGUAGES"
Action: add
Added in version 4.7.0-339
Description Add a new language.
Input Parameters
Name Type Notes Required?
code string Example Values
, ab, aa, af, sq, am, ar, hy, as, ay, az, ba, eu, bn, dz, bh, bi, br, bg, my, be, km, ca, zh, co, hr, cs, da, nl, en-uk, en-us, eo, et, fo, fj, fi, fr, fy, gd, gl, ka, de, el, kl, gn, gu, ha, iw, hi, hu, ...
Yes
lang_file string Yes
Action: changeCurrentUserLanguage
Added in version 4.8.0-393
Description Change the current language.
Action: delete
Added in version 4.7.0-339
Description Delete a language file.
Input Parameters
Name Type Notes Required?
code string Example Values
pl, de, ru, it, tr, hu, sv, sk, es, zh, da, nl, fr, cs, pt
Yes
Action: listLanguages
Added in version 4.8.0-393
Description List languages available for use in interworx.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’code’ => ’pl’,
’language’ => ’Polish’,
’status’ => ’unused’,
),
1 =>
array (
’code’ => ’de’,
’language’ => ’German’,
’status’ => ’unused’,
),
2 =>
array (
’code’ => ’ru’,
’language’ => ’Russian’,
’status’ => ’unused’,
),
),
)
Action: queryChangeCurrentUserLanguage
Added in version 5.1.0-838
Description Displays the information available to the action "changeCurrentUserLanguage".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’language_copy’ => ’en-us’,
’language’ => ’en-us’,
),
)
Action: syncLanguage
Added in version 4.7.0-339
Description Trigger language synchronization for a node.
Input Parameters
Name Type Notes Required?
code string Example Values
pl, de, ru, it, tr, en-us, hu, sv, sk, es, zh, da, nl, fr, cs, pt
Yes

24 Controller: /nodeworx/logout

Action: logout
Added in version 4.8.0-393
Description Logout of NodeWorx.

25 Controller: /nodeworx/logs

Required Permissions "IWORXLOGS"
Action: view
Added in version 4.7.0-339
Description View system logs.
Input Parameters
Name Type Notes Required?
group string Example Values
IWorx, Dns, System, Ftp, Mysql, Ssh, Mail, Http
Yes

26 Controller: /nodeworx/mail/imap

Required Permissions "EMAIL"
Action: isRunning
Added in version 4.7.0-339
Description Checks if the service is running or not.
Sample output
array (
’status’ => 0,
’payload’ => true,
)
Action: isRunningOnNode
Added in version 4.7.0-339
Description Checks if the service is running on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: listGeneralName
Added in version 4.7.0-339
Description Lists the "normal" name - ie "web server" instead of "httpd".
Sample output
array (
’status’ => 0,
’payload’ => ’##LG_IMAP##’,
)
Action: listPortNumbers
Added in version 4.7.0-339
Description Lists a string of the port numbers that this service uses, comma-seperated.
Sample output
array (
’status’ => 0,
’payload’ => ’143’,
)
Action: listPortNumbersArray
Added in version 4.7.0-339
Description Lists array of port numbers and ranges that this service uses.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => 143,
),
)
Action: listRequiredPermissions
Added in version 4.7.0-339
Description Lists an array of permissions required to control the service.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’EMAIL’,
),
)
Action: listServiceInfo
Added in version 4.7.0-339
Description Lists the service name, ports, page, and status.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’id’ => ’imap4’,
’name’ => ’##LG_IMAP##’,
’ports’ => ’143’,
’page’ => ’/nodeworx/mail/mda’,
’ctrl’ => ’/nodeworx/mail/imap’,
’is_running’ => 1,
),
)
Action: listServiceName
Added in version 4.7.0-339
Description Lists the service name - ie "httpd" instead of "web server".
Sample output
array (
’status’ => 0,
’payload’ => ’imap4’,
)
Action: listServicePage
Added in version 4.7.0-339
Description Lists the page that controls the service.
Sample output
array (
’status’ => 0,
’payload’ => ’/nodeworx/mail/mda’,
)
Action: queryUpdate
Added in version 5.1.0-838
Description Displays the information available to the action "update".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’imap_version’ => ’2.1.2 (courier-imap)’,
’imap_mem_limit’ => ’256000000’,
’imap_max_connections’ => ’40’,
’imap_secure_mem_limit’ => ’256000000’,
’imap_secure_max_connections’ => ’40’,
),
)
Action: restart
Added in version 4.7.0-339
Description Restarts the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: restartOnNode
Added in version 4.7.0-339
Description Restarts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: start
Added in version 4.7.0-339
Description Starts the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: startOnBoot
Added in version 4.7.0-339
Description Action function that handles imap4 start-on-boot status changing.
Input Parameters
Name Type Notes Required?
mda_imap_startonboot integer Example Values
1, 0
Example Default Value
1
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: startOnNode
Added in version 4.7.0-339
Description Starts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: stop
Added in version 4.7.0-339
Description Stops the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: stopOnNode
Added in version 4.7.0-339
Description Stops the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: update
Added in version 4.7.0-339
Description Update IMAP4 server settings.
Input Parameters
Name Type Notes Required?
imap_mem_limit integer Description
(In Bytes)
Example Default Value
256000000
No*
imap_max_connections integer Example Default Value
40
No*
imap_secure_mem_limit integer Description
(In Bytes)
Example Default Value
256000000
No*
imap_secure_max_connections integer Example Default Value
40
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value

27 Controller: /nodeworx/mail/mda

Required Permissions "EMAIL"
Action: startOnBootIMAP4
Added in version 4.7.0-339
Description Deprecated.
Warning This action has been deprecated as of version 4.2.0-260. Use Ctrl_Nodeworx_MailImap::startOnBoot
Input Parameters
Name Type Notes Required?
mda_imap_startonboot integer Example Values
1, 0
Example Default Value
1
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: startOnBootPop3
Added in version 4.7.0-339
Description Deprecated.
Warning This action has been deprecated as of version 4.2.0-260. Use Ctrl_Nodeworx_MailPop3::startOnBoot
Input Parameters
Name Type Notes Required?
mda_pop_startonboot integer Example Values
1, 0
Example Default Value
1
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: startOnBootSIMAP4
Added in version 4.7.0-339
Description Deprecated.
Warning This action has been deprecated as of version 4.2.0-260. Use Ctrl_Nodeworx_MailSImap::startOnBoot
Input Parameters
Name Type Notes Required?
mda_simap_startonboot integer Example Values
1, 0
Example Default Value
1
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: startOnBootSPOP3
Added in version 4.7.0-339
Description Deprecated.
Warning This action has been deprecated as of version 4.2.0-260. Use Ctrl_Nodeworx_MailSpop3::startOnBoot
Input Parameters
Name Type Notes Required?
mda_spop_startonboot integer Example Values
1, 0
Example Default Value
1
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: updateImap
Added in version 4.7.0-339
Description Deprecated.
Warning This action has been deprecated as of version 4.2.0-260. Use Ctrl_Nodeworx_MailImap::update
Input Parameters
Name Type Notes Required?
imap_mem_limit integer Description
(In Bytes)
Example Default Value
256000000
No*
imap_max_connections integer Example Default Value
40
No*
imap_secure_mem_limit integer Description
(In Bytes)
Example Default Value
256000000
No*
imap_secure_max_connections integer Example Default Value
40
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: updatePop3
Added in version 4.7.0-339
Description Deprecated.
Warning This action has been deprecated as of version 4.2.0-260. Use Ctrl_Nodeworx_MailPop3::update
Input Parameters
Name Type Notes Required?
pop3_mem_limit integer Description
(In Bytes)
Example Default Value
256000000
No*
pop3_max_connections integer Example Default Value
200
No*
pop3_secure_mem_limit integer Description
(In Bytes)
Example Default Value
256000000
No*
pop3_secure_max_connections integer Example Default Value
40
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value

28 Controller: /nodeworx/mail/mta

Required Permissions "EMAIL"
Action: disableLocalDelivery
Added in version 4.8.0-393
Description Bulk Disable local mail delivery for domains on the system.
Input Parameters
Name Type Notes Required?
domain struct (string) Example Values
example.com, sub.example.com, pointer.com, secondary.com
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: enableLocalDelivery
Added in version 4.8.0-393
Description Bulk Enable local mail delivery for domains on the system.
Input Parameters
Name Type Notes Required?
domain struct (string) Example Values
example.com, sub.example.com, pointer.com, secondary.com
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: queryUpdateBounce
Added in version 5.1.0-838
Description Displays the information available to the action "updateBounce".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’bounce_from’ => ’mailer-daemon’,
’bounce_host’ => ’p1.unit.interworx.com’,
’double_bounce_messages’ => ’0’,
’double_bounce_to’ => ’doublebounce’,
’double_bounce_host’ => ’p1.unit.interworx.com’,
),
)
Action: queryUpdateGeneral
Added in version 5.1.0-838
Description Displays the information available to the action "updateGeneral".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’mailserver_hostname’ => ’p1.unit.interworx.com’,
’default_domain’ => ’unit.interworx.com’,
),
)
Action: updateBounce
Added in version 4.7.0-339
Description Update the mail server "bounce" settings.
Input Parameters
Name Type Notes Required?
bounce_from string Help Entry
The email address / user that bounced messages are sent as.
Example Default Value
mailer-daemon
No*
bounce_host string Help Entry
The hostname or IP that bounced messages are sent as.
Example Default Value
p1.unit.interworx.com
No*
double_bounce_messages integer Help Entry
Setting this to ’yes’ will allow Qmail to double bounce e-mail messages.
Example Values
1, 0
Example Default Value
0
No*
double_bounce_to string Help Entry
The e-mail address to double bounce messages to.
Example Default Value
doublebounce
No*
double_bounce_host string Help Entry
The hostname or IP that double bounced messages are sent as.
Example Default Value
p1.unit.interworx.com
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: updateGeneral
Added in version 4.7.0-339
Description Update mail server default-domain and hostname.
Input Parameters
Name Type Notes Required?
mailserver_hostname string Help Entry
The mail server hostname.
Example Default Value
p1.unit.interworx.com
No*
default_domain string Help Entry
The default domain appending to any address that does not include a domain portion (i.e. a missing @domain.com will be translated to use the default domain).
Example Default Value
unit.interworx.com
No
* indicates that it’s actually required, but probably already has a valid default value
Action: updateInbound
Added in version 4.7.0-339
Description Deprecated.
Warning This action has been deprecated as of version 4.2.0-260. Use Ctrl_Nodeworx_MailSmtp::updateInbound
Input Parameters
Name Type Notes Required?
smtp_greeting string Help Entry
The SMTP greeting shown to mail servers when they connect to the SMTP daemon on this server. This must begin with a fully qualified domain name (FQDN) per RFC 2821.
Example Default Value
p1.unit.interworx.com InterWorx-CP SMTP Server
No*
concurrency_incoming integer Help Entry
The total number of inbound remote connections allowed simultaneously.
Example Default Value
20
No*
timeout_smtpd integer Description
In Seconds
Help Entry
The max seconds to wait for communication for inbound SMTP connections.
Example Default Value
1200
No*
databytes integer Description
MB, (0 is Unlimited)
Help Entry
Maximum filesize (in megabytes) allowed for incoming messages
Example Default Value
20
No*
mta_level_outgoing_email_address_blacklist struct (string) No
mta_level_email_address_blacklist struct (string) Help Entry
The MTA level blacklist allows you to blacklist e-mail addresses at a very low level so they are denied before further processing takes place.
Example Default Value
[".*\\ @.*","!.*@.*\\..*",".*%.*"]
No
realtime_sbl_blacklists struct (string) Example Default Value
["bl.spamcop.net"]
No
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: updateOutbound
Added in version 4.7.0-339
Description Deprecated.
Warning This action has been deprecated as of version 4.2.0-260. Use Ctrl_Nodeworx_MailSend::update
Input Parameters
Name Type Notes Required?
concurrency_remote integer Help Entry
The concurrency remote tells Qmail the maximum number of outbound connections that it can have open at any one time.
Example Default Value
255
No*
timeout_remote integer Description
In Seconds
Help Entry
"Timeout Remote" changes the amount of time that Qmail will wait for a remote connection to respond to most communications.
Example Default Value
600
No*
timeout_connect integer Description
In Seconds
Help Entry
"Timeout Connect" changes the amount of time that Qmail will wait for a remote connection to an SMTP server.
Example Default Value
60
No*
queue_lifetime integer Description
In Seconds
Help Entry
Queue lifetime limits the number of seconds that a mail entry will live in the queue before it is delivered or purged.
Example Default Value
604800
No*
smtp_routes struct (string) Help Entry
Artificial SMTP routes. If the domain matches the host, qmail-remote will connect to relay, as if host had relay as its only MX Record. The syntax for this field is [domain]:[destination server] and [domain] may be blank if you want all mail to be routed to [destination server]
No
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: updateRrd
Added in version 4.7.0-339
Description Show or hide the mail server RRD graph in the web interface.
Input Parameters
Name Type Notes Required?
rrd integer Help Entry
A graph showing the number of messages in the queue.
Example Values
1, 0
Example Default Value
0
No*
* indicates that it’s actually required, but probably already has a valid default value

29 Controller: /nodeworx/mail/pop3

Required Permissions "EMAIL"
Action: isRunning
Added in version 4.7.0-339
Description Checks if the service is running or not.
Sample output
array (
’status’ => 0,
’payload’ => true,
)
Action: isRunningOnNode
Added in version 4.7.0-339
Description Checks if the service is running on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: listGeneralName
Added in version 4.7.0-339
Description Lists the "normal" name - ie "web server" instead of "httpd".
Sample output
array (
’status’ => 0,
’payload’ => ’##LG_POP3##’,
)
Action: listPortNumbers
Added in version 4.7.0-339
Description Lists a string of the port numbers that this service uses, comma-seperated.
Sample output
array (
’status’ => 0,
’payload’ => ’110’,
)
Action: listPortNumbersArray
Added in version 4.7.0-339
Description Lists array of port numbers and ranges that this service uses.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => 110,
),
)
Action: listRequiredPermissions
Added in version 4.7.0-339
Description Lists an array of permissions required to control the service.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’EMAIL’,
),
)
Action: listServiceInfo
Added in version 4.7.0-339
Description Lists the service name, ports, page, and status.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’id’ => ’pop3’,
’name’ => ’##LG_POP3##’,
’ports’ => ’110’,
’page’ => ’/nodeworx/mail/mda’,
’ctrl’ => ’/nodeworx/mail/pop3’,
’is_running’ => 1,
),
)
Action: listServiceName
Added in version 4.7.0-339
Description Lists the service name - ie "httpd" instead of "web server".
Sample output
array (
’status’ => 0,
’payload’ => ’pop3’,
)
Action: listServicePage
Added in version 4.7.0-339
Description Lists the page that controls the service.
Sample output
array (
’status’ => 0,
’payload’ => ’/nodeworx/mail/mda’,
)
Action: queryUpdate
Added in version 5.1.0-838
Description Displays the information available to the action "update".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’pop3_version’ => ’1.03 (qmail-pop3d)’,
’pop3_mem_limit’ => ’256000000’,
’pop3_max_connections’ => ’200’,
’pop3_secure_mem_limit’ => ’256000000’,
’pop3_secure_max_connections’ => ’40’,
),
)
Action: restart
Added in version 4.7.0-339
Description Restarts the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: restartOnNode
Added in version 4.7.0-339
Description Restarts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: start
Added in version 4.7.0-339
Description Starts the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: startOnBoot
Added in version 4.7.0-339
Description Set pop3 start-on-boot status.
Input Parameters
Name Type Notes Required?
mda_pop_startonboot integer Example Values
1, 0
Example Default Value
1
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: startOnNode
Added in version 4.7.0-339
Description Starts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: stop
Added in version 4.7.0-339
Description Stops the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: stopOnNode
Added in version 4.7.0-339
Description Stops the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: update
Added in version 4.7.0-339
Description Update POP3 server settings.
Input Parameters
Name Type Notes Required?
pop3_mem_limit integer Description
(In Bytes)
Example Default Value
256000000
No*
pop3_max_connections integer Example Default Value
200
No*
pop3_secure_mem_limit integer Description
(In Bytes)
Example Default Value
256000000
No*
pop3_secure_max_connections integer Example Default Value
40
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value

30 Controller: /nodeworx/mail/queue

Required Permissions "EMAIL"
Action: delete
Added in version 4.8.0-393
Description Delete messages from the queue.
Input Parameters
Name Type Notes Required?
message_id struct (integer) No*
* indicates that it’s actually required, but probably already has a valid default value
Action: expire
Added in version 4.8.0-393
Description Expire messages in the queue.
Input Parameters
Name Type Notes Required?
message_id struct (integer) No*
* indicates that it’s actually required, but probably already has a valid default value
Action: listStats
Added in version 4.8.0-393
Description Lists information about current queue statistics.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’queue’ => ’remote’,
’count’ => ’0’,
),
1 =>
array (
’queue’ => ’local’,
’count’ => ’0’,
),
2 =>
array (
’queue’ => ’todo’,
’count’ => ’0’,
),
),
)
Action: process
Added in version 4.7.0-339
Description Sends the ALRM signal to qmail, which tells it to process the mail queue.
Action: purge
Added in version 4.7.0-339
Description Purge mail queue.
Input Parameters
Name Type Notes Required?
queue struct (string) Help Entry
Use the dropdown to purge emails sitting in the selected queues.
Example Values
all, remote, local, todo
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: queryQueue
Added in version 4.8.0-393
Description Lists the contents of the selected queue.
Input Parameters
Name Type Notes Required?
queue string Help Entry
Use the dropdown to choose which email queue to view the message id, date, size, from and to of the emails within.
Example Values
all, remote, local, todo
Yes
Action: sendTestMessage
Added in version 4.8.0-393
Description Send a test message to see if the mail delivery is working.
Input Parameters
Name Type Notes Required?
email string Yes
subject string Yes
body string No
Action: unexpire
Added in version 4.8.0-393
Description Unexpire messages in the queue.
Input Parameters
Name Type Notes Required?
message_id struct (integer) No*
* indicates that it’s actually required, but probably already has a valid default value

31 Controller: /nodeworx/mail/send

Required Permissions "EMAIL"
Action: isRunning
Added in version 4.7.0-339
Description Checks if the service is running or not.
Sample output
array (
’status’ => 0,
’payload’ => true,
)
Action: isRunningOnNode
Added in version 4.7.0-339
Description Checks if the service is running on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: listGeneralName
Added in version 4.7.0-339
Description Lists the "normal" name - ie "web server" instead of "httpd".
Sample output
array (
’status’ => 0,
’payload’ => ’##LG_OUTBOUND_MAIL##’,
)
Action: listPortNumbers
Added in version 4.7.0-339
Description Lists a string of the port numbers that this service uses, comma-seperated.
Sample output
array (
’status’ => 0,
’payload’ => ’##LG_NOT_APPLICABLE##’,
)
Action: listPortNumbersArray
Added in version 4.7.0-339
Description Lists array of port numbers and ranges that this service uses.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’##LG_NOT_APPLICABLE##’,
),
)
Action: listRequiredPermissions
Added in version 4.7.0-339
Description Lists an array of permissions required to control the service.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’EMAIL’,
),
)
Action: listServiceInfo
Added in version 4.7.0-339
Description Lists the service name, ports, page, and status.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’id’ => ’send’,
’name’ => ’##LG_OUTBOUND_MAIL##’,
’ports’ => ’##LG_NOT_APPLICABLE##’,
’page’ => ’/nodeworx/mail/mta’,
’ctrl’ => ’/nodeworx/mail/send’,
’is_running’ => 1,
),
)
Action: listServiceName
Added in version 4.7.0-339
Description Lists the service name - ie "httpd" instead of "web server".
Sample output
array (
’status’ => 0,
’payload’ => ’send’,
)
Action: listServicePage
Added in version 4.7.0-339
Description Lists the page that controls the service.
Sample output
array (
’status’ => 0,
’payload’ => ’/nodeworx/mail/mta’,
)
Action: queryUpdate
Added in version 5.1.0-838
Description Displays the information available to the action "update".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’concurrency_remote’ => ’255’,
’timeout_remote’ => ’600’,
’timeout_connect’ => ’60’,
’queue_lifetime’ => ’604800’,
’smtp_routes’ =>
array (
),
),
)
Action: restart
Added in version 4.7.0-339
Description Restarts the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: restartOnNode
Added in version 4.7.0-339
Description Restarts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: start
Added in version 4.7.0-339
Description Starts the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: startOnNode
Added in version 4.7.0-339
Description Starts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: stop
Added in version 4.7.0-339
Description Stops the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: stopOnNode
Added in version 4.7.0-339
Description Stops the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: update
Added in version 4.7.0-339
Description Update misc outbound mail server settings.
Input Parameters
Name Type Notes Required?
concurrency_remote integer Help Entry
The concurrency remote tells Qmail the maximum number of outbound connections that it can have open at any one time.
Example Default Value
255
No*
timeout_remote integer Description
In Seconds
Help Entry
"Timeout Remote" changes the amount of time that Qmail will wait for a remote connection to respond to most communications.
Example Default Value
600
No*
timeout_connect integer Description
In Seconds
Help Entry
"Timeout Connect" changes the amount of time that Qmail will wait for a remote connection to an SMTP server.
Example Default Value
60
No*
queue_lifetime integer Description
In Seconds
Help Entry
Queue lifetime limits the number of seconds that a mail entry will live in the queue before it is delivered or purged.
Example Default Value
604800
No*
smtp_routes struct (string) Help Entry
Artificial SMTP routes. If the domain matches the host, qmail-remote will connect to relay, as if host had relay as its only MX Record. The syntax for this field is [domain]:[destination server] and [domain] may be blank if you want all mail to be routed to [destination server]
No
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value

32 Controller: /nodeworx/mail/simap

Required Permissions "EMAIL"
Action: isRunning
Added in version 4.7.0-339
Description Checks if the service is running or not.
Sample output
array (
’status’ => 0,
’payload’ => true,
)
Action: isRunningOnNode
Added in version 4.7.0-339
Description Checks if the service is running on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: listGeneralName
Added in version 4.7.0-339
Description Lists the "normal" name - ie "web server" instead of "httpd".
Sample output
array (
’status’ => 0,
’payload’ => ’##LG_SECURE_IMAP##’,
)
Action: listPortNumbers
Added in version 4.7.0-339
Description Lists a string of the port numbers that this service uses, comma-seperated.
Sample output
array (
’status’ => 0,
’payload’ => ’993’,
)
Action: listPortNumbersArray
Added in version 4.7.0-339
Description Lists array of port numbers and ranges that this service uses.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => 993,
),
)
Action: listRequiredPermissions
Added in version 4.7.0-339
Description Lists an array of permissions required to control the service.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’EMAIL’,
),
)
Action: listServiceInfo
Added in version 4.7.0-339
Description Lists the service name, ports, page, and status.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’id’ => ’imap4-ssl’,
’name’ => ’##LG_SECURE_IMAP##’,
’ports’ => ’993’,
’page’ => ’/nodeworx/mail/mda’,
’ctrl’ => ’/nodeworx/mail/simap’,
’is_running’ => 1,
),
)
Action: listServiceName
Added in version 4.7.0-339
Description Lists the service name - ie "httpd" instead of "web server".
Sample output
array (
’status’ => 0,
’payload’ => ’imap4-ssl’,
)
Action: listServicePage
Added in version 4.7.0-339
Description Lists the page that controls the service.
Sample output
array (
’status’ => 0,
’payload’ => ’/nodeworx/mail/mda’,
)
Action: restart
Added in version 4.7.0-339
Description Restarts the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: restartOnNode
Added in version 4.7.0-339
Description Restarts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: start
Added in version 4.7.0-339
Description Starts the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: startOnBoot
Added in version 4.7.0-339
Description Set secure imap4 start-on-boot status.
Input Parameters
Name Type Notes Required?
mda_simap_startonboot integer Example Values
1, 0
Example Default Value
1
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: startOnNode
Added in version 4.7.0-339
Description Starts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: stop
Added in version 4.7.0-339
Description Stops the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: stopOnNode
Added in version 4.7.0-339
Description Stops the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value

33 Controller: /nodeworx/mail/smtp

Required Permissions "EMAIL"
Action: isRunning
Added in version 4.7.0-339
Description Checks if the service is running or not.
Sample output
array (
’status’ => 0,
’payload’ => true,
)
Action: isRunningOnNode
Added in version 4.7.0-339
Description Checks if the service is running on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: listGeneralName
Added in version 4.7.0-339
Description Lists the "normal" name - ie "web server" instead of "httpd".
Sample output
array (
’status’ => 0,
’payload’ => ’##LG_SMTPSERVER##’,
)
Action: listPortNumbers
Added in version 4.7.0-339
Description Lists a string of the port numbers that this service uses, comma-seperated.
Sample output
array (
’status’ => 0,
’payload’ => ’25’,
)
Action: listPortNumbersArray
Added in version 4.7.0-339
Description Lists array of port numbers and ranges that this service uses.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => 25,
),
)
Action: listRequiredPermissions
Added in version 4.7.0-339
Description Lists an array of permissions required to control the service.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’EMAIL’,
),
)
Action: listServiceInfo
Added in version 4.7.0-339
Description Lists the service name, ports, page, and status.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’id’ => ’smtp’,
’name’ => ’##LG_SMTPSERVER##’,
’ports’ => ’25’,
’page’ => ’/nodeworx/mail/mta’,
’ctrl’ => ’/nodeworx/mail/smtp’,
’is_running’ => 1,
),
)
Action: listServiceName
Added in version 4.7.0-339
Description Lists the service name - ie "httpd" instead of "web server".
Sample output
array (
’status’ => 0,
’payload’ => ’smtp’,
)
Action: listServicePage
Added in version 4.7.0-339
Description Lists the page that controls the service.
Sample output
array (
’status’ => 0,
’payload’ => ’/nodeworx/mail/mta’,
)
Action: queryUpdate
Added in version 5.1.0-838
Description Displays the information available to the action "update".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’version’ => ’1.03 (qmail)’,
’primary_smtp_port’ => ’25’,
’auth_mode’ => ’auth_optional/tls_optional’,
),
)
Action: queryUpdateInbound
Added in version 5.1.0-838
Description Displays the information available to the action "updateInbound".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’smtp_greeting’ => ’p1.unit.interworx.com InterWorx-CP SMTP Server’,
’concurrency_incoming’ => ’20’,
’timeout_smtpd’ => ’1200’,
’databytes’ => ’20’,
’mta_level_outgoing_email_address_blacklist’ =>
array (
),
’mta_level_email_address_blacklist’ =>
array (
0 => ’.*\\ @.*’,
1 => ’!.*@.*\\..*’,
2 => ’.*%.*’,
),
’realtime_sbl_blacklists’ =>
array (
0 => ’bl.spamcop.net’,
),
),
)
Action: restart
Added in version 4.7.0-339
Description Restarts the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: restartOnNode
Added in version 4.7.0-339
Description Restarts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: start
Added in version 4.7.0-339
Description Starts the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: startOnNode
Added in version 4.7.0-339
Description Starts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: stop
Added in version 4.7.0-339
Description Stops the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: stopOnNode
Added in version 4.7.0-339
Description Stops the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: update
Added in version 4.7.0-339
Description Change the auth settings for the primary SMTP server.
Input Parameters
Name Type Notes Required?
auth_mode string Example Values
auth_no/tls_no, auth_no/tls_optional, auth_optional/tls_no, auth_withtls/tls_optional, auth_optional/tls_optional
Example Default Value
auth_optional/tls_optional
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: updateInbound
Added in version 4.7.0-339
Description Update misc inbound mail server settings.
Input Parameters
Name Type Notes Required?
smtp_greeting string Help Entry
The SMTP greeting shown to mail servers when they connect to the SMTP daemon on this server. This must begin with a fully qualified domain name (FQDN) per RFC 2821.
Example Default Value
p1.unit.interworx.com InterWorx-CP SMTP Server
No*
concurrency_incoming integer Help Entry
The total number of inbound remote connections allowed simultaneously.
Example Default Value
20
No*
timeout_smtpd integer Description
In Seconds
Help Entry
The max seconds to wait for communication for inbound SMTP connections.
Example Default Value
1200
No*
databytes integer Description
MB, (0 is Unlimited)
Help Entry
Maximum filesize (in megabytes) allowed for incoming messages
Example Default Value
20
No*
mta_level_outgoing_email_address_blacklist struct (string) No
mta_level_email_address_blacklist struct (string) Help Entry
The MTA level blacklist allows you to blacklist e-mail addresses at a very low level so they are denied before further processing takes place.
Example Default Value
[".*\\ @.*","!.*@.*\\..*",".*%.*"]
No
realtime_sbl_blacklists struct (string) Example Default Value
["bl.spamcop.net"]
No
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value

34 Controller: /nodeworx/mail/smtp2

Required Permissions "EMAIL"
Action: isRunning
Added in version 4.7.0-339
Description Checks if the service is running or not.
Sample output
array (
’status’ => 0,
’payload’ => false,
)
Action: isRunningOnNode
Added in version 4.7.0-339
Description Checks if the service is running on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: listGeneralName
Added in version 4.7.0-339
Description Lists the "normal" name - ie "web server" instead of "httpd".
Sample output
array (
’status’ => 0,
’payload’ => ’##LG_ALTERNATE_INBOUND_SMTP_SERVER##’,
)
Action: listPortNumbers
Added in version 4.7.0-339
Description Lists a string of the port numbers that this service uses, comma-seperated.
Sample output
array (
’status’ => 0,
’payload’ => ’Success’,
)
Action: listPortNumbersArray
Added in version 4.7.0-339
Description Lists array of port numbers and ranges that this service uses.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’’,
),
)
Action: listRequiredPermissions
Added in version 4.7.0-339
Description Lists an array of permissions required to control the service.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’EMAIL’,
),
)
Action: listServiceInfo
Added in version 4.7.0-339
Description Lists the service name, ports, page, and status.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’id’ => ’smtp2’,
’name’ => ’##LG_ALTERNATE_INBOUND_SMTP_SERVER##’,
’ports’ => ’’,
’page’ => ’/nodeworx/mail/mta’,
’ctrl’ => ’/nodeworx/mail/smtp2’,
’is_running’ => 0,
),
)
Action: listServiceName
Added in version 4.7.0-339
Description Lists the service name - ie "httpd" instead of "web server".
Sample output
array (
’status’ => 0,
’payload’ => ’smtp2’,
)
Action: listServicePage
Added in version 4.7.0-339
Description Lists the page that controls the service.
Sample output
array (
’status’ => 0,
’payload’ => ’/nodeworx/mail/mta’,
)
Action: restart
Added in version 4.7.0-339
Description Restarts the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: restartOnNode
Added in version 4.7.0-339
Description Restarts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: start
Added in version 4.7.0-339
Description Starts the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: startOnNode
Added in version 4.7.0-339
Description Starts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: stop
Added in version 4.7.0-339
Description Stops the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: stopOnNode
Added in version 4.7.0-339
Description Stops the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: update
Added in version 4.7.0-339
Description Change the auth settings for the alternate port SMTP server.
Input Parameters
Name Type Notes Required?
alternate_smtp_port integer Description
Port 587 Recommended
Help Entry
This is the port for running your alternate SMTP server. The default (and recommended) port is 587 but can be any usable port on the box.
Example Default Value
587
No*
auth_mode string Example Values
auth_yes/tls_yes, auth_yes/tls_optional
Example Default Value
0
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value

35 Controller: /nodeworx/mail/spam

Required Permissions "EMAIL"
Action: addAdvanced
Added in version 4.7.0-339
Description Displays the add advanced form.
Input Parameters
Name Type Notes Required?
preference string Example Values
add_header, all_spam_to, always_trust_envelope_sender, auto_whitelist_db_modules, auto_whitelist_factor, bayes_auto_expire, bayes_auto_learn_threshold_nonspam, bayes_auto_learn_threshold_spam, bayes_expiry_max_db_size, bayes_ignore_from, bayes_ignore_header, bayes_ignore_header header_name, bayes_ignore_to, bayes_journal_max_size, bayes_learn_during_report, bayes_learn_to_journal, bayes_min_ham_num, bayes_min_spam_num, bayes_use_chi2_combining, bayes_use_hapaxes, blacklist_to, clear_headers, clear_report_template, clear_unsafe_report_template, dcc_body_max, dcc_fuz1_max, dcc_fuz2_max, dcc_timeout, def_whitelist_auth, def_whitelist_from_rcvd, describe, dns_available, envelope_sender_header, fold_headers, internal_networks, lock_method, more_spam_to, ok_languages, ok_locales, pyzor_max, pyzor_options, pyzor_timeout, razor_timeout, rbl_timeout, remove_header, report, report_charset, report_contact, report_hostname, report_safe_copy_headers, ...
Yes
value string Yes
Action: autoRestart
Added in version 4.7.0-339
Description Set the spamassassin auto-restart status.
Input Parameters
Name Type Notes Required?
spam_autorestart integer Example Values
1, 0
Example Default Value
0
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: deleteAdvanced
Added in version 4.7.0-339
Description Delete advanced spamassassin configuration.
Input Parameters
Name Type Notes Required?
pref_id struct (integer) Yes
Action: editAdvanced
Added in version 4.7.0-339
Description Edit advanced spamassassin configuration.
Input Parameters
Name Type Notes Required?
pref_id integer Yes
value string Example Default Value
test
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: isRunning
Added in version 4.7.0-339
Description Checks if the service is running or not.
Sample output
array (
’status’ => 0,
’payload’ => true,
)
Action: isRunningOnNode
Added in version 4.7.0-339
Description Checks if the service is running on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: listGeneralName
Added in version 4.7.0-339
Description Lists the "normal" name - ie "web server" instead of "httpd".
Sample output
array (
’status’ => 0,
’payload’ => ’##LG_SPAM_FILTERING##’,
)
Action: listPortNumbers
Added in version 4.7.0-339
Description Lists a string of the port numbers that this service uses, comma-seperated.
Sample output
array (
’status’ => 0,
’payload’ => ’783’,
)
Action: listPortNumbersArray
Added in version 4.7.0-339
Description Lists array of port numbers and ranges that this service uses.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => 783,
),
)
Action: listPreferences
Added in version 4.8.0-393
Description Lists information about current spam preferences.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
6 =>
array (
’prefid’ => ’6’,
’username’ => ’@GLOBAL’,
’preference’ => ’add_header’,
’value’ => ’test’,
’is_invalid_nw’ => false,
’is_invalid_sw’ => false,
),
5 =>
array (
’prefid’ => ’5’,
’username’ => ’@GLOBAL’,
’preference’ => ’bayes_auto_learn’,
’value’ => ’1’,
’is_invalid_nw’ => true,
’is_invalid_sw’ => false,
),
1 =>
array (
’prefid’ => ’1’,
’username’ => ’@GLOBAL’,
’preference’ => ’report_safe’,
’value’ => ’1’,
’is_invalid_nw’ => true,
’is_invalid_sw’ => true,
),
3 =>
array (
’prefid’ => ’3’,
’username’ => ’@GLOBAL’,
’preference’ => ’rewrite_header subject’,
’value’ => ’’,
’is_invalid_nw’ => true,
’is_invalid_sw’ => true,
),
2 =>
array (
’prefid’ => ’2’,
’username’ => ’@GLOBAL’,
’preference’ => ’use_auto_whitelist’,
’value’ => ’1’,
’is_invalid_nw’ => true,
’is_invalid_sw’ => false,
),
4 =>
array (
’prefid’ => ’4’,
’username’ => ’@GLOBAL’,
’preference’ => ’use_bayes’,
’value’ => ’1’,
’is_invalid_nw’ => true,
’is_invalid_sw’ => false,
),
),
)
Action: listRequiredPermissions
Added in version 4.7.0-339
Description Lists an array of permissions required to control the service.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’EMAIL’,
),
)
Action: listServiceInfo
Added in version 4.7.0-339
Description Lists the service name, ports, page, and status.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’id’ => ’spamassassin’,
’name’ => ’##LG_SPAM_FILTERING##’,
’ports’ => ’783’,
’page’ => ’/nodeworx/mail/spam’,
’ctrl’ => ’/nodeworx/mail/spam’,
’is_running’ => 1,
),
)
Action: listServiceName
Added in version 4.7.0-339
Description Lists the service name - ie "httpd" instead of "web server".
Sample output
array (
’status’ => 0,
’payload’ => ’spamassassin’,
)
Action: listServicePage
Added in version 4.7.0-339
Description Lists the page that controls the service.
Sample output
array (
’status’ => 0,
’payload’ => ’/nodeworx/mail/spam’,
)
Action: queryAutoRestart
Added in version 5.1.0-838
Description Displays the information available to the action "autoRestart".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’spam_autorestart’ => ’0’,
),
)
Action: queryEditAdvanced
Added in version 5.1.0-838
Description Displays the information available to the action "editAdvanced".
Input Parameters
Name Type Notes Required?
pref_id integer Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’preference’ => ’add_header’,
’value’ => ’test’,
’pref_id’ => ’6’,
),
)
Action: queryUpdateBayes
Added in version 5.1.0-838
Description Displays the information available to the action "updateBayes".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’bayes_scanning’ => ’1’,
’bayes_auto_learn’ => ’1’,
’bayes_imap_training’ => ’1’,
’bayes_imap_training_limit’ => ’250’,
’global_bayes_database’ => ’0’,
),
)
Action: queryUpdateLists
Added in version 5.1.0-838
Description Displays the information available to the action "updateLists".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’global_whitelist’ =>
array (
),
’global_blacklist’ =>
array (
),
’trusted_networks’ =>
array (
),
),
)
Action: queryUpdateOptions
Added in version 5.1.0-838
Description Displays the information available to the action "updateOptions".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’smtp_level_scanning’ => ’0’,
’smtp_level_spam_score’ => ’95’,
’spam_max_filesize’ => ’262144’,
’rewrite_header_subject’ => ’’,
’report_safe’ => ’1’,
’use_auto_whitelist’ => ’1’,
),
)
Action: restart
Added in version 4.7.0-339
Description Restarts the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: restartOnNode
Added in version 4.7.0-339
Description Restarts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: start
Added in version 4.7.0-339
Description Starts the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: startonboot
Added in version 4.7.0-339
Description Set the spamassassin start-on-boot status.
Input Parameters
Name Type Notes Required?
startonboot integer Example Values
1, 0
Example Default Value
1
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: startOnNode
Added in version 4.7.0-339
Description Starts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: stop
Added in version 4.7.0-339
Description Stops the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: stopOnNode
Added in version 4.7.0-339
Description Stops the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: updateBayes
Added in version 4.7.0-339
Description Update spamassassin bayes configuration.
Input Parameters
Name Type Notes Required?
bayes_scanning integer Help Entry
Use the dropdown to enable or disable Bayes scanning. Given training, Bayes will learn which emails are most likely spam and most likely ham (not spam) and deal with these emails according to your preferences.
Example Values
1, 0
Example Default Value
1
No*
bayes_auto_learn integer Help Entry
Use the dropdown to enable or disable Bayes auto learning. If enabled, the system will automatically train the Bayes database by analyzing messages that have a score that strongly suggests that they are spam or non-spam.
Example Values
1, 0
Example Default Value
1
No*
bayes_imap_training integer Help Entry
Use the dropdown to enable or disable IMAP training. With Bayes IMAP training enabled, there will be two folders created for all e-mail accounts on the system: "Learn Spam" and "Learn Ham". You can then put SPAM emails in the "Learn Spam" folder and non-spam in the "Learn Ham" folder. This will train the Bayes system on which emails are Spam and which are Ham (not Spam). The training occurs once daily, after which the folders’ contents are purged.
Example Values
1, 0
Example Default Value
1
No*
bayes_imap_training_limit integer Description
Per Day
Help Entry
The maximum number of e-mails that will be trained from each of the IMAP Training Folders, "Learn Spam" and "Learn Ham," each day.
Example Default Value
250
No*
global_bayes_database integer Help Entry
Use the dropdown to enable or disable the Bayes global database. If enabled, all the Bayes data will be stored as a single global user. If disabled, each e-mail box user will have their own Bayes database to store Bayesian data. "Disabled" is considered more effective for fighting Spam, but requires all e-mail users to train their messages individually, and uses more disk space, compared to the global database option.
Example Values
1, 0
Example Default Value
0
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: updateLists
Added in version 4.7.0-339
Description Update spamassassin global white and black lists.
Input Parameters
Name Type Notes Required?
global_whitelist struct (string) Help Entry
Use the whitelist text field to enter email addresses or domains that are valid to send email from on a server-wide level.
No
global_blacklist struct (string) Help Entry
Use the blacklist text field to enter email addresses or domains that are not valid to send email from on a server-wide level. To block all emails from a domain, use ’*’, as in ’*@domain.com’.
No
trusted_networks struct (string) Help Entry
Relay hosts added here are considered to not be potentially operated by spammers, open relays, or open proxies.
No
Action: updateOptions
Added in version 4.7.0-339
Description Update spamassassin options.
Input Parameters
Name Type Notes Required?
smtp_level_scanning integer Help Entry
This option will scan all e-mail using the SpamAssassin content filter as the e-mail enters the server. The SMTP connection will be dropped only if the Spam Score is higher than the SMTP Spam Score option below. Otherwise, the e-mail will still be delivered to the recipient.<br><br><strong>WARNING</strong>: You may not want to enable this setting. It has no bearing on the SpamAssassin setting in SiteWorx, so e-mail messages may be scanned twice if this setting is enabled.
Example Values
1, 0
Example Default Value
0
No*
smtp_level_spam_score double Help Entry
<b>SMTP Spam Score.</b> This is the SpamAssassin score threshold at which the SMTP server will reject a message before local delivery begins. If you do not want to block any spam at the SMTP level, use a very high number.
Example Default Value
95
No*
spam_max_filesize double Help Entry
Set the maximum message size to be scanned — any bigger than this threshold and the message will be returned unprocessed.
Example Default Value
262144
No*
rewrite_header_subject string Help Entry
Emails marked as Spam will have the email subject rewritten with what is entered here.
No
report_safe integer Help Entry
This option sets the method of delivering the actual e-mail spam message. The email can be sent unchanged but with the subject rewritten, it can be attached to an email from SpamAssassin, or it can be attached as plain text to an email from SpamAssassin.
Example Values
0, 1, 2
Example Default Value
1
No*
use_auto_whitelist integer Help Entry
Enable or disable the SpamAssassin AutoWhitelist functionality.
Example Values
1, 0
Example Default Value
1
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value

36 Controller: /nodeworx/mail/spop3

Required Permissions "EMAIL"
Action: isRunning
Added in version 4.7.0-339
Description Checks if the service is running or not.
Sample output
array (
’status’ => 0,
’payload’ => true,
)
Action: isRunningOnNode
Added in version 4.7.0-339
Description Checks if the service is running on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: listGeneralName
Added in version 4.7.0-339
Description Lists the "normal" name - ie "web server" instead of "httpd".
Sample output
array (
’status’ => 0,
’payload’ => ’##LG_SECURE_POP3##’,
)
Action: listPortNumbers
Added in version 4.7.0-339
Description Lists a string of the port numbers that this service uses, comma-seperated.
Sample output
array (
’status’ => 0,
’payload’ => ’995’,
)
Action: listPortNumbersArray
Added in version 4.7.0-339
Description Lists array of port numbers and ranges that this service uses.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => 995,
),
)
Action: listRequiredPermissions
Added in version 4.7.0-339
Description Lists an array of permissions required to control the service.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’EMAIL’,
),
)
Action: listServiceInfo
Added in version 4.7.0-339
Description Lists the service name, ports, page, and status.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’id’ => ’pop3-ssl’,
’name’ => ’##LG_SECURE_POP3##’,
’ports’ => ’995’,
’page’ => ’/nodeworx/mail/mda’,
’ctrl’ => ’/nodeworx/mail/spop3’,
’is_running’ => 1,
),
)
Action: listServiceName
Added in version 4.7.0-339
Description Lists the service name - ie "httpd" instead of "web server".
Sample output
array (
’status’ => 0,
’payload’ => ’pop3-ssl’,
)
Action: listServicePage
Added in version 4.7.0-339
Description Lists the page that controls the service.
Sample output
array (
’status’ => 0,
’payload’ => ’/nodeworx/mail/mda’,
)
Action: restart
Added in version 4.7.0-339
Description Restarts the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: restartOnNode
Added in version 4.7.0-339
Description Restarts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: start
Added in version 4.7.0-339
Description Starts the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: startOnBoot
Added in version 4.7.0-339
Description Set secure pop3 start-on-boot status.
Input Parameters
Name Type Notes Required?
mda_spop_startonboot integer Example Values
1, 0
Example Default Value
1
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: startOnNode
Added in version 4.7.0-339
Description Starts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: stop
Added in version 4.7.0-339
Description Stops the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: stopOnNode
Added in version 4.7.0-339
Description Stops the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value

37 Controller: /nodeworx/mail/virus

Required Permissions "EMAIL"
Action: autoRestart
Added in version 4.7.0-339
Description Set the clamav autorestart status.
Input Parameters
Name Type Notes Required?
clamav_autorestart integer Help Entry
With this option on you can have ClamAV restarted automatically if ClamAV goes down unexpectedly.
Example Values
1, 0
Example Default Value
0
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: isRunning
Added in version 4.7.0-339
Description Checks if the service is running or not.
Sample output
array (
’status’ => 0,
’payload’ => true,
)
Action: isRunningOnNode
Added in version 4.7.0-339
Description Checks if the service is running on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: listGeneralName
Added in version 4.7.0-339
Description Lists the "normal" name - ie "web server" instead of "httpd".
Sample output
array (
’status’ => 0,
’payload’ => ’##LG_VIRUS_FILTERING##’,
)
Action: listPortNumbers
Added in version 4.7.0-339
Description Lists a string of the port numbers that this service uses, comma-seperated.
Sample output
array (
’status’ => 0,
’payload’ => ’3310’,
)
Action: listPortNumbersArray
Added in version 4.7.0-339
Description Lists array of port numbers and ranges that this service uses.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => 3310,
),
)
Action: listRequiredPermissions
Added in version 4.7.0-339
Description Lists an array of permissions required to control the service.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’EMAIL’,
),
)
Action: listServiceInfo
Added in version 4.7.0-339
Description Lists the service name, ports, page, and status.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’id’ => ’clamd’,
’name’ => ’##LG_VIRUS_FILTERING##’,
’ports’ => ’3310’,
’page’ => ’/nodeworx/mail/virus’,
’ctrl’ => ’/nodeworx/mail/virus’,
’is_running’ => 1,
),
)
Action: listServiceName
Added in version 4.7.0-339
Description Lists the service name - ie "httpd" instead of "web server".
Sample output
array (
’status’ => 0,
’payload’ => ’clamd’,
)
Action: listServicePage
Added in version 4.7.0-339
Description Lists the page that controls the service.
Sample output
array (
’status’ => 0,
’payload’ => ’/nodeworx/mail/virus’,
)
Action: options
Added in version 4.7.0-339
Description Update clamav options.
Input Parameters
Name Type Notes Required?
clamav_smtpscanning integer Help Entry
Use the dropdown to enable or disable email virus scanning on the server level.
Example Values
1, 0
Example Default Value
0
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: queryAutoRestart
Added in version 5.1.0-838
Description Displays the information available to the action "autoRestart".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’clamav_autorestart’ => ’0’,
),
)
Action: queryOptions
Added in version 5.1.0-838
Description Displays the information available to the action "options".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’clamav_smtpscanning’ => ’0’,
),
)
Action: restart
Added in version 4.7.0-339
Description Restarts the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: restartOnNode
Added in version 4.7.0-339
Description Restarts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: start
Added in version 4.7.0-339
Description Starts the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: startOnBoot
Added in version 4.7.0-339
Description Set the clamav start-on-boot status.
Input Parameters
Name Type Notes Required?
clamav_startonboot integer Help Entry
With this option on you can have ClamAV restarted automatically if ClamAV goes down unexpectedly.
Example Values
1, 0
Example Default Value
1
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: startOnNode
Added in version 4.7.0-339
Description Starts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: stop
Added in version 4.7.0-339
Description Stops the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: stopOnNode
Added in version 4.7.0-339
Description Stops the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value

38 Controller: /nodeworx/mysql

Required Permissions "MYSQL"
Action: add
Added in version 4.7.0-339
Description Add a new mysql server to the pool.
Warning This action has been deprecated as of version 4.8.0-393. 2011-03-30 Use Ctrl_Nodeworx_MysqlRemote::add
Input Parameters
Name Type Notes Required?
nickname string Yes
host string Help Entry
Enter the host or IP address (with port if needed) of the database server.
Yes
root_username string Help Entry
The root username of the MySQL Server. Note: this is *not* the system root username.
Yes
root_password string Help Entry
The root password of the MySQL Server. Note: this is *not* the system root password.
Yes
Action: autoRestart
Added in version 4.7.0-339
Description Set the mysql server auto-restart status.
Input Parameters
Name Type Notes Required?
autorestart integer Help Entry
With this option on you can have MySQL restarted automatically if MySQL goes down unexpectedly.
Example Values
1, 0
Example Default Value
0
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: default
Added in version 4.7.0-339
Description Sets the default mysql server to use for new SiteWorx accounts and resellers.
Warning This action has been deprecated as of version 4.8.0-393. 2011-03-30 Use Ctrl_Nodeworx_MysqlRemote::default
Input Parameters
Name Type Notes Required?
server string Help Entry
Select the database server from the list that you would like to use.
Example Values
localhost
Yes
Action: isRunning
Added in version 4.7.0-339
Description Checks if the service is running or not.
Sample output
array (
’status’ => 0,
’payload’ => true,
)
Action: isRunningOnNode
Added in version 4.7.0-339
Description Checks if the service is running on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: list
Added in version 4.7.0-339
Description List MySQL servers.
Warning This action has been deprecated as of version 4.8.0-393. 2011-03-30 Use Ctrl_Nodeworx_MysqlRemote::listServers
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’localhost’,
),
)
Action: listActiveServers
Added in version 4.7.0-339
Description List active MySQL servers.
Warning This action has been deprecated as of version 4.8.0-393. 2011-03-30 Use Ctrl_Nodeworx_MysqlRemote::listActiveServers
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’localhost’,
),
)
Action: listDeletableServers
Added in version 4.7.0-339
Description List deletable MySQL servers.
Warning This action has been deprecated as of version 4.8.0-393. 2011-03-30 Use Ctrl_Nodeworx_MysqlRemote::listDeletableServers
Sample output
array (
’status’ => 0,
’payload’ =>
array (
),
)
Action: listGeneralName
Added in version 4.7.0-339
Description Lists the "normal" name - ie "web server" instead of "httpd".
Sample output
array (
’status’ => 0,
’payload’ => ’##LG_MYSQLSERVER##’,
)
Action: listInactiveServers
Added in version 4.7.0-339
Description List inactive MySQL servers.
Warning This action has been deprecated as of version 4.8.0-393. 2011-03-30 Use Ctrl_Nodeworx_MysqlRemote::listInactiveServers
Sample output
array (
’status’ => 0,
’payload’ =>
array (
),
)
Action: listPortNumbers
Added in version 4.7.0-339
Description Lists a string of the port numbers that this service uses, comma-seperated.
Sample output
array (
’status’ => 0,
’payload’ => ’3306’,
)
Action: listPortNumbersArray
Added in version 4.7.0-339
Description Lists array of port numbers and ranges that this service uses.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => 3306,
),
)
Action: listRequiredPermissions
Added in version 4.7.0-339
Description Lists an array of permissions required to control the service.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’MYSQL’,
),
)
Action: listServiceInfo
Added in version 4.7.0-339
Description Lists the service name, ports, page, and status.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’id’ => ’mysqld’,
’name’ => ’##LG_MYSQLSERVER##’,
’ports’ => ’3306’,
’page’ => ’/nodeworx/mysql’,
’ctrl’ => ’/nodeworx/mysql’,
’is_running’ => 1,
),
)
Action: listServiceName
Added in version 4.7.0-339
Description Lists the service name - ie "httpd" instead of "web server".
Sample output
array (
’status’ => 0,
’payload’ => ’mysqld’,
)
Action: listServicePage
Added in version 4.7.0-339
Description Lists the page that controls the service.
Sample output
array (
’status’ => 0,
’payload’ => ’/nodeworx/mysql’,
)
Action: nickname
Added in version 4.7.0-339
Description Change a mysql server’s nickname.
Warning This action has been deprecated as of version 4.8.0-393. 2011-03-30 Use Ctrl_Nodeworx_MysqlRemote::nickname
Input Parameters
Name Type Notes Required?
server string Help Entry
Select the database server from the list that you would like to use.
Example Values
localhost
Yes
Action: options
Added in version 4.7.0-339
Description Configure various mysql service options.
Input Parameters
Name Type Notes Required?
max_connections integer Help Entry
The number of connections to the MySQL server allowed at once.
Example Default Value
151
No*
max_connect_errors integer Help Entry
If set, the server blocks further connections from a remote host when the number of interrupted connections from that host exceeds this number. You can unblock a host with the command FLUSH HOSTS.
Example Default Value
10
No*
connect_timeout integer Description
In Seconds
Help Entry
The number in seconds of MySQL connection timeout. This is also used for the first answer from the server.
Example Default Value
10
No*
wait_timeout integer Description
In Seconds
Help Entry
The number of seconds the server waits for activity on a connection before closing it.
Example Default Value
28800
No*
key_buffer_size integer Description
In Bytes
Help Entry
This is the memory buffer shared by all threads. Other buffers used by the server are allocated as needed.
Example Default Value
8384512
No*
sort_buffer_size integer Description
In Bytes
Help Entry
The size of the buffer used when sorting table data. The default value is 1MB. This option is available only for isamchk.
Example Default Value
2097144
No*
read_buffer_size integer Description
In Bytes
Help Entry
The size of the buffer used to store data being read from files. The default value is 260KB. This option is available only for isamchk.
Example Default Value
131072
No*
max_allowed_packet integer Description
In Bytes
Help Entry
Set the maximum packet length to send to or receive from the server. The default value is 16MB.
Example Default Value
1048576
No*
thread_cache_size integer Help Entry
The number of open tables for all threads. Increasing this value increases the number of file descriptors that mysqld requires.
Example Default Value
0
No*
table_open_cache integer Help Entry
Set the number of open tables cached. Table cache is related to max connections. For example, for 200 concurrent running connections, you should have a table cache of at least 200 * N, where N is the maximum number of tables in a join. You also need to reserve some extra file descriptors for temporary tables and files.
Example Default Value
64
No*
query_cache_limit integer Description
In Bytes
Help Entry
Set the maximum size of individual query results that can be cached. The default value is 1MB.
Example Default Value
1048576
No*
query_cache_size integer Description
In Bytes
Help Entry
Set the size of the query cache. Setting it to 0 disables the query cache. The default cache size is 0.
Example Default Value
0
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: queryAutoRestart
Added in version 5.1.0-838
Description Displays the information available to the action "autoRestart".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’autorestart’ => ’0’,
),
)
Action: queryOptions
Added in version 5.1.0-838
Description Displays the information available to the action "options".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’max_connections’ => ’151’,
’max_connect_errors’ => ’10’,
’connect_timeout’ => ’10’,
’wait_timeout’ => ’28800’,
’key_buffer_size’ => ’8384512’,
’sort_buffer_size’ => ’2097144’,
’read_buffer_size’ => ’131072’,
’max_allowed_packet’ => ’1048576’,
’thread_cache_size’ => ’0’,
’table_open_cache’ => ’64’,
’query_cache_limit’ => ’1048576’,
’query_cache_size’ => ’0’,
),
)
Action: queryProcesses
Added in version 4.8.0-393
Description Query processes on the local mysql server.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’id’ => ’10376’,
’username’ => ’iworx’,
’command’ => ’Sleep’,
’time’ => ’1’,
),
1 =>
array (
’id’ => ’10377’,
’username’ => ’iworx’,
’command’ => ’Query’,
’time’ => ’0’,
),
),
)
Action: restart
Added in version 4.7.0-339
Description Restarts the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: restartOnNode
Added in version 4.7.0-339
Description Restarts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: rootpass
Added in version 4.7.0-339
Description Change the given MySQL Server’s root password.
Input Parameters
Name Type Notes Required?
password string Yes
confirm_password string Help Entry
Confirm the password field by providing it again. Must match the password provided.
Yes
Action: rrdGraph
Added in version 4.7.0-339
Description Set the mysql server connections RRD graph display status.
Input Parameters
Name Type Notes Required?
rrd integer Help Entry
Use the dropdown to turn the MySQL server activity graph on or off.
Example Values
1, 0
Example Default Value
0
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: start
Added in version 4.7.0-339
Description Starts the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: startOnBoot
Added in version 4.7.0-339
Description Set the mysql server start-on-boot-status.
Input Parameters
Name Type Notes Required?
startonboot integer Help Entry
If set to ’Yes’, MySQL will be automatically started when the server starts up.
Example Values
1, 0
Example Default Value
1
No*
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: startOnNode
Added in version 4.7.0-339
Description Starts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: stop
Added in version 4.7.0-339
Description Stops the service.
Input Parameters
Name Type Notes Required?
cascade_to_nodes integer Help Entry
Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually
Example Values
1
No
Action: stopOnNode
Added in version 4.7.0-339
Description Stops the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value

39 Controller: /nodeworx/mysql/remote

Required Permissions "MYSQL"
Action: activate
Added in version 4.8.0-393
Description Reactivate a mysql server if it has gone offline.
Input Parameters
Name Type Notes Required?
server string Help Entry
Select the database server from the list that you would like to use.
Example Values
localhost
Yes
root_username string Help Entry
The root username of the MySQL Server. Note: this is *not* the system root username.
Yes
root_password string Help Entry
The root password of the MySQL Server. Note: this is *not* the system root password.
Yes
Action: add
Added in version 4.8.0-393
Description Add a new mysql server to the pool.
Input Parameters
Name Type Notes Required?
nickname string Yes
host string Help Entry
Enter the host or IP address (with port if needed) of the database server.
Yes
root_username string Help Entry
The root username of the MySQL Server. Note: this is *not* the system root username.
Yes
root_password string Help Entry
The root password of the MySQL Server. Note: this is *not* the system root password.
Yes
Action: default
Added in version 4.8.0-393
Description Sets the default mysql server to use for new SiteWorx accounts and resellers.
Action: listActiveServers
Added in version 4.8.0-393
Description List active MySQL servers.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’localhost’,
),
)
Action: listDeletableServers
Added in version 4.8.0-393
Description List deletable MySQL servers.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
),
)
Action: listInactiveServers
Added in version 4.8.0-393
Description List inactive MySQL servers.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
),
)
Action: listServers
Added in version 4.8.0-393
Description Lists the available mysql servers.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’server_id’ => ’1’,
’nickname’ => ’localhost’,
’can_delete’ => false,
’version’ => ’5.1.73’,
’host’ => ’10.1.15.200’,
’is_running’ => true,
’can_connect’ => true,
’is_local’ => true,
),
),
)
Action: nickname
Added in version 4.8.0-393
Description Change a mysql server’s nickname.
Input Parameters
Name Type Notes Required?
server string Help Entry
Select the database server from the list that you would like to use.
Example Values
localhost
Yes
Action: queryDefault
Added in version 5.1.0-838
Description Displays the information available to the action "default".
Input Parameters
Name Type Notes Required?
server string Help Entry
Select the database server from the list that you would like to use.
Example Values
localhost
Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’server_copy’ => ’localhost’,
’server’ => ’localhost’,
),
)
Action: queryProcesses
Added in version 4.8.0-393
Description Query processes on the local mysql server.
Input Parameters
Name Type Notes Required?
server string Example Values
localhost
Yes
Action: rootpass
Added in version 4.8.0-393
Description Change the given MySQL Server’s root password.
Input Parameters
Name Type Notes Required?
server string Help Entry
Select the database server from the list that you would like to use.
Example Values
localhost
Yes
password string Yes
confirm_password string Help Entry
Confirm the password field by providing it again. Must match the password provided.
Yes

40 Controller: /nodeworx/nfs

Required Permissions "NFS"
Action: isRunning
Added in version 4.7.0-339
Description Checks if the service is running or not.
Sample output
array (
’status’ => 0,
’payload’ => false,
)
Action: isRunningOnNode
Added in version 4.7.0-339
Description Checks if the service is running on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: listGeneralName
Added in version 4.7.0-339
Description Lists the "normal" name - ie "web server" instead of "httpd".
Sample output
array (
’status’ => 0,
’payload’ => ’##LG_NFS_SERVER##’,
)
Action: listPortNumbers
Added in version 4.7.0-339
Description Lists a string of the port numbers that this service uses, comma-seperated.
Sample output
array (
’status’ => 0,
’payload’ => ’2049’,
)
Action: listPortNumbersArray
Added in version 4.7.0-339
Description Lists array of port numbers and ranges that this service uses.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => 2049,
),
)
Action: listRequiredPermissions
Added in version 4.7.0-339
Description Lists an array of permissions required to control the service.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’NFS’,
),
)
Action: listServiceInfo
Added in version 4.7.0-339
Description Lists the service name, ports, page, and status.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’id’ => ’nfs’,
’name’ => ’##LG_NFS_SERVER##’,
’ports’ => ’2049’,
’page’ => ’/nodeworx/nfs’,
’ctrl’ => ’/nodeworx/nfs’,
’is_running’ => 0,
),
)
Action: listServiceName
Added in version 4.7.0-339
Description Lists the service name - ie "httpd" instead of "web server".
Sample output
array (
’status’ => 0,
’payload’ => ’nfs’,
)
Action: listServicePage
Added in version 4.7.0-339
Description Lists the page that controls the service.
Sample output
array (
’status’ => 0,
’payload’ => ’/nodeworx/nfs’,
)
Action: restart
Added in version 4.7.0-339
Description Restarts the service.
Action: restartOnNode
Added in version 4.7.0-339
Description Restarts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: start
Added in version 4.7.0-339
Description Starts the service.
Action: startOnBoot
Added in version 4.7.0-339
Description Set the NFS start-on-boot status.
Input Parameters
Name Type Notes Required?
nfs_startonboot integer Example Values
1, 0
Example Default Value
0
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: startOnNode
Added in version 4.7.0-339
Description Starts the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value
Action: stop
Added in version 4.7.0-339
Description Stops the service.
Action: stopOnNode
Added in version 4.7.0-339
Description Stops the service on a specific node (Clustering only).
Input Parameters
Name Type Notes Required?
node_id string No*
* indicates that it’s actually required, but probably already has a valid default value

41 Controller: /nodeworx/nfs/export

Required Permissions "NFS"
Action: add
Added in version 4.7.0-339
Description Add a NFS Export.
Input Parameters
Name Type Notes Required?
directory_to_export string Yes
ip_allow_list struct (string) No*
read_write_access string Example Values
ro, rw
Yes
root_user_access string Example Values
root_squash, no_root_squash
Yes
sync_options string Example Values
async, sync
Yes
* indicates that it’s actually required, but probably already has a valid default value
Action: listNfsExports
Added in version 4.8.0-393
Description List NFS Exports.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
),
)

42 Controller: /nodeworx/nfs/mount

Required Permissions "NFS"
Action: add
Added in version 4.7.0-339
Description Add a NFS mount.
Input Parameters
Name Type Notes Required?
host string Help Entry
The host (hostname or IP address) you are mounting.
Yes
remote_directory string Help Entry
The full path of the remote directory you are mounting.
Yes
mount_point string Help Entry
The local mount point you would like the remote directory to be available on. This must be an existing directory.
Yes
protocol string Example Values
tcp, udp
No
mount_type string Example Values
hard, soft
No
remount_options string Description
(On Error)
Example Values
fg, bg
No
interrupt_handling string Description
(For File Operations)
Example Values
intr, nointr
No
Action: listNfsMounts
Added in version 4.8.0-393
Description List Nfs mounts.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
),
)

43 Controller: /nodeworx/notice

Required Permissions "LOGIN"
Action: dismissBanner
Added in version 4.7.0-339
Description Dismisses a banner notice.
Input Parameters
Name Type Notes Required?
delivery_id integer No*
* indicates that it’s actually required, but probably already has a valid default value
Action: ignoreUntil
Added in version 4.7.0-339
Description Ignore a notice until a certain time.
Input Parameters
Name Type Notes Required?
delivery_id struct (integer) Yes
ignore_until integer Example Values
0, 1, 2, 3, 4, 5
Yes
Action: listBannerNotices
Added in version 4.7.0-339
Description Lists current banner notices.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’delivery_id’ => ’1’,
’code’ => ’’,
’priority’ => ’positive’,
’node_id’ => ’’,
’subject’ => ’##LG_WELCOMETONODEWORX##’,
’body’ => ’##LG_GOIWORX_WELCOME##’,
’date_created’ => ’1417708365’,
),
1 =>
array (
’delivery_id’ => ’79371’,
’code’ => ’SSL_CERT_EXPIRED’,
’priority’ => ’negative’,
’node_id’ => ’’,
’subject’ => ’Warning: SSL Certificate Expired’,
’body’ => ’##LG_PROBLEM_CERT_EXPIRED_MESSAGE|<ul><li>Web-Server Default SSL<ul><li>Expiration Date: 2015-12-04</li><li>Domain: p1.unit.interworx.com</li><li>Issuer: SomeOrganization</li></ul></li><li>FTP Server<ul><li>Expiration Date: 2015-12-04</li><li>Domain: *.interworx.com</li><li>Issuer: InterWorx, LLC</li></ul></li><li>POP3-SSL<ul><li>Expiration Date: 2015-12-04</li><li>Domain: localhost</li><li>Issuer: Courier Mail Server</li></ul></li><li>IMAP-SSL<ul><li>Expiration Date: 2015-12-04</li><li>Domain: localhost</li><li>Issuer: Courier Mail Server</li></ul></li><li>SMTP-TLS<ul><li>Expiration Date: 2015-08-19</li><li>Domain: localhost</li><li>Issuer: Qmail Toaster Server</li></ul></li></ul>##’,
’date_created’ => ’1507458762’,
),
2 =>
array (
’delivery_id’ => ’79375’,
’code’ => ’UPGRADED_6.0.13-1384’,
’priority’ => ’positive’,
’node_id’ => ’’,
’subject’ => ’##LG_IWORX_UPGRADED##’,
’body’ => ’##LG_IWORX_UPGRADED_DESC|6.0.13-1384##’,
’date_created’ => ’1507623831’,
),
),
)
Action: removeUnsubscription
Added in version 4.7.0-339
Description Removes an unsubscription block for the current user.
Input Parameters
Name Type Notes Required?
code integer Yes
Action: unsubscribe
Added in version 4.7.0-339
Description Unsubscribes the current user from a problem code.
Input Parameters
Name Type Notes Required?
code string Yes

44 Controller: /nodeworx/overview

Action: editProfile
Added in version 4.8.3-414
Description Edit the currently authenticated users’ profile.
Input Parameters
Name Type Notes Required?
theme string Example Values
blue_steel, calliope, coolfreshness, heliotrope, interstate, interworx, nexcess, vanillaice
Example Default Value
calliope
No*
language string Example Values
pl, de, ru, it, tr, en-us, hu, sv, sk, es, zh, da, nl, fr, cs, pt
Example Default Value
en-us
No*
menu_style string Example Values
big, small
Example Default Value
big
No*
password string No
confirm_password string Help Entry
Confirm the password field by providing it again. Must match the password provided.
No
* indicates that it’s actually required, but probably already has a valid default value
Action: listHostname
Added in version 4.7.0-339
Description List the hostname of the system.
Sample output
array (
’status’ => 0,
’payload’ => ’apidoc.interworx.com’,
)
Action: listIsClusterable
Added in version 5.0.14-579
Description List the clusterable status of this license.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’is_clusterable’ => true,
),
)
Action: listLicenseKey
Added in version 4.7.0-339
Description List the interworx license key.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’licence_key’ => ’INTERWORX_APIDOC2’,
),
)
Action: listLoadAverage
Added in version 4.7.0-339
Description Lists the one, five, and fifteen-minute load averages.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’one_minute’ => ’0.55’,
’five_minute’ => ’0.29’,
’fifteen_minute’ => ’0.11’,
),
)
Action: listServiceStatus
Added in version 4.7.0-339
Description Lists the status and port numbers of InterWorx-managed services.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’id’ => ’httpd’,
’name’ => ’##LG_APACHE##’,
’ports’ => ’80, 443’,
’page’ => ’/nodeworx/http’,
’ctrl’ => ’/nodeworx/http’,
’is_running’ => 1,
),
1 =>
array (
’id’ => ’pop3’,
’name’ => ’##LG_POP3##’,
’ports’ => ’110’,
’page’ => ’/nodeworx/mail/mda’,
’ctrl’ => ’/nodeworx/mail/pop3’,
’is_running’ => 1,
),
2 =>
array (
’id’ => ’pop3-ssl’,
’name’ => ’##LG_SECURE_POP3##’,
’ports’ => ’995’,
’page’ => ’/nodeworx/mail/mda’,
’ctrl’ => ’/nodeworx/mail/spop3’,
’is_running’ => 1,
),
),
)
Action: listVersion
Added in version 4.7.0-339
Description List the version of InterWorx installed.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’version’ => ’6.0.13-1384’,
),
)
Action: listVPSStatus
Added in version 5.0.14-579
Description List the VPS status of the system.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’is_vps’ => true,
),
)
Action: listVPSVendor
Added in version 5.0.14-579
Description List the VPS status of the system.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’vps_vendor’ => ’xen’,
),
)
Action: queryEditProfile
Added in version 5.1.0-838
Description Displays the information available to the action "editProfile".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’theme’ => ’calliope’,
’language’ => ’en-us’,
’menu_style’ => ’big’,
’password’ => NULL,
’confirm_password’ => NULL,
),
)

45 Controller: /nodeworx/packages

Required Permissions "PACKAGES"
Action: add
Added in version 4.7.0-339
Description Add a siteworx package.
Input Parameters
Name Type Notes Required?
package_name string Yes
OPT_STORAGE double Description
Megabytes
Help Entry
The amount of storage space allowed in megabytes
Yes
OPT_BANDWIDTH double Description
Gigabytes / Month
Help Entry
The amount of bandwidth allowed per month in gigabytes
Yes
OPT_EMAIL_ALIASES integer Help Entry
The number of e-mail aliases (often called e-mail forwards) allowed
Yes
OPT_EMAIL_AUTORESPONDERS integer Help Entry
The number of e-mail autoresponders, also called robots, allowed
Yes
OPT_EMAIL_BOXES integer Help Entry
The number of POP3/IMAP e-mail boxes allowed
Yes
OPT_EMAIL_GROUPS integer Help Entry
The number of group e-mail (aliases that send to multiple recipients) accounts allowed
Yes
OPT_FTP_ACCOUNTS integer Help Entry
The number of FTP accounts allowed
Yes
OPT_MYSQL_DBS integer Help Entry
The number of MySQL databases allowed
Yes
OPT_MYSQL_DB_USERS integer Help Entry
The number of MySQL users allowed
Yes
OPT_POINTER_DOMAINS integer Help Entry
The number of domains that can be pointed to this domain. Sometimes called "parked" domains.
Yes
OPT_SLAVE_DOMAINS integer Help Entry
The number of secondary domains allowed. Sometimes called "add-on" domains.
Yes
OPT_SUBDOMAINS integer Help Entry
The number of subdomains allowed
Yes
OPT_BACKUP integer Help Entry
Enables the ability to backup the account
Example Values
1, 0
Yes
OPT_CGI_ACCESS integer Help Entry
Indicator of whether or not CGI script access is enabled
Example Values
1, 0
Yes
OPT_CRONTAB integer Help Entry
Access to Crontab
Example Values
1, 0
Yes
OPT_DNS_RECORDS integer Help Entry
If yes, the SiteWorx account will be able to edit its own DNS records. (MX, SPF, and Domainkeys records are not effected by this setting)
Example Values
1, 0
Yes
OPT_SSL integer Help Entry
Enable SSL Certificates
Example Values
1, 0
Yes
OPT_BURSTABLE integer Help Entry
If you choose to be "burstable" your site will be able to go over its bandwidth allotment, perhaps at an extra cost (depending on the agreement). If you choose no, your bandwidth will be capped at a predefined limit and you will not be able to transfer any more data once the transfer limit is reached.
Example Values
1, 0
Yes
OPT_SAVE_XFER_LOGS integer Help Entry
If you answer yes to saving the transfer logs, the transfer logs will be saved in a format that can be downloaded. If you answer no, your logs are not saved and can not be downloaded and analyzed offline.
Example Values
1, 0
Yes
is_default integer Example Values
1, 0
Example Default Value
0
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: backup
Added in version 4.8.3-414
Description Backup a siteworx package.
Input Parameters
Name Type Notes Required?
id struct (integer) Yes
Action: delete
Added in version 4.7.0-339
Description Delete a siteworx package.
Input Parameters
Name Type Notes Required?
id struct (integer) Yes
Action: edit
Added in version 4.7.0-339
Description Edit a siteworx package.
Input Parameters
Name Type Notes Required?
id integer Yes
package_name string Example Default Value
unlimited
No*
OPT_STORAGE double Description
Megabytes
Help Entry
The amount of storage space allowed in megabytes
Example Default Value
999999999
No*
OPT_BANDWIDTH double Description
Gigabytes / Month
Help Entry
The amount of bandwidth allowed per month in gigabytes
Example Default Value
999999999
No*
OPT_EMAIL_ALIASES integer Help Entry
The number of e-mail aliases (often called e-mail forwards) allowed
Example Default Value
999999999
No*
OPT_EMAIL_AUTORESPONDERS integer Help Entry
The number of e-mail autoresponders, also called robots, allowed
Example Default Value
999999999
No*
OPT_EMAIL_BOXES integer Help Entry
The number of POP3/IMAP e-mail boxes allowed
Example Default Value
999999999
No*
OPT_EMAIL_GROUPS integer Help Entry
The number of group e-mail (aliases that send to multiple recipients) accounts allowed
Example Default Value
999999999
No*
OPT_FTP_ACCOUNTS integer Help Entry
The number of FTP accounts allowed
Example Default Value
999999999
No*
OPT_MYSQL_DBS integer Help Entry
The number of MySQL databases allowed
Example Default Value
999999999
No*
OPT_MYSQL_DB_USERS integer Help Entry
The number of MySQL users allowed
Example Default Value
999999999
No*
OPT_POINTER_DOMAINS integer Help Entry
The number of domains that can be pointed to this domain. Sometimes called "parked" domains.
Example Default Value
999999999
No*
OPT_SLAVE_DOMAINS integer Help Entry
The number of secondary domains allowed. Sometimes called "add-on" domains.
Example Default Value
999999999
No*
OPT_SUBDOMAINS integer Help Entry
The number of subdomains allowed
Example Default Value
999999999
No*
OPT_BACKUP integer Help Entry
Enables the ability to backup the account
Example Values
1, 0
Example Default Value
1
No*
OPT_CGI_ACCESS integer Help Entry
Indicator of whether or not CGI script access is enabled
Example Values
1, 0
Example Default Value
1
No*
OPT_CRONTAB integer Help Entry
Access to Crontab
Example Values
1, 0
Example Default Value
1
No*
OPT_DNS_RECORDS integer Help Entry
If yes, the SiteWorx account will be able to edit its own DNS records. (MX, SPF, and Domainkeys records are not effected by this setting)
Example Values
1, 0
Example Default Value
1
No*
OPT_SSL integer Help Entry
Enable SSL Certificates
Example Values
1, 0
Example Default Value
1
No*
OPT_BURSTABLE integer Help Entry
If you choose to be "burstable" your site will be able to go over its bandwidth allotment, perhaps at an extra cost (depending on the agreement). If you choose no, your bandwidth will be capped at a predefined limit and you will not be able to transfer any more data once the transfer limit is reached.
Example Values
1, 0
Example Default Value
1
No*
OPT_SAVE_XFER_LOGS integer Help Entry
If you answer yes to saving the transfer logs, the transfer logs will be saved in a format that can be downloaded. If you answer no, your logs are not saved and can not be downloaded and analyzed offline.
Example Values
1, 0
Example Default Value
1
No*
is_default integer Example Values
1, 0
Example Default Value
0
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: import
Added in version 4.8.3-414
Description Import a siteworx package.
Input Parameters
Name Type Notes Required?
package_file string Yes
overwrite integer Example Values
1
No
Action: listDetails
Added in version 4.7.0-339
Description Lists SiteWorx package details.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’id’ => ’8’,
’name’ => ’unlimited’,
’OPT_STORAGE’ => 999999999,
’OPT_BANDWIDTH’ => 999999999,
’OPT_EMAIL_ALIASES’ => 999999999,
’OPT_EMAIL_AUTORESPONDERS’ => 999999999,
’OPT_EMAIL_BOXES’ => 999999999,
’OPT_EMAIL_GROUPS’ => 999999999,
’OPT_FTP_ACCOUNTS’ => 999999999,
’OPT_MYSQL_DBS’ => 999999999,
’OPT_MYSQL_DB_USERS’ => 999999999,
’OPT_POINTER_DOMAINS’ => 999999999,
’OPT_SLAVE_DOMAINS’ => 999999999,
’OPT_SUBDOMAINS’ => 999999999,
’OPT_BACKUP’ => true,
’OPT_CGI_ACCESS’ => true,
’OPT_CRONTAB’ => true,
’OPT_DNS_RECORDS’ => true,
’OPT_SSL’ => true,
’OPT_BURSTABLE’ => true,
’OPT_SAVE_XFER_LOGS’ => true,
),
1 =>
array (
’id’ => ’9’,
’name’ => ’fifteens’,
’OPT_STORAGE’ => 15,
’OPT_BANDWIDTH’ => 15,
’OPT_EMAIL_ALIASES’ => 15,
’OPT_EMAIL_AUTORESPONDERS’ => 15,
’OPT_EMAIL_BOXES’ => 15,
’OPT_EMAIL_GROUPS’ => 15,
’OPT_FTP_ACCOUNTS’ => 15,
’OPT_MYSQL_DBS’ => 15,
’OPT_MYSQL_DB_USERS’ => 15,
’OPT_POINTER_DOMAINS’ => 15,
’OPT_SLAVE_DOMAINS’ => 15,
’OPT_SUBDOMAINS’ => 15,
’OPT_BACKUP’ => true,
’OPT_CGI_ACCESS’ => true,
’OPT_CRONTAB’ => true,
’OPT_DNS_RECORDS’ => true,
’OPT_SSL’ => true,
’OPT_BURSTABLE’ => true,
’OPT_SAVE_XFER_LOGS’ => true,
),
),
)
Action: listIds
Added in version 4.7.0-339
Description List SiteWorx packages by id.
Warning This action has been deprecated as of version 4.8.0-393. 2011-01-18 Use listPackages instead
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
0 => ’8’,
1 => ’unlimited’,
),
1 =>
array (
0 => ’9’,
1 => ’fifteens’,
),
),
)
Action: listPackages
Added in version 4.8.0-393
Description List SiteWorx Packages.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’id’ => ’8’,
’name’ => ’unlimited’,
’options’ => ’OPT_STORAGE=999999999,OPT_BANDWIDTH=999999999,OPT_EMAIL_ALIASES=999999999,OPT_EMAIL_AUTORESPONDERS=999999999,OPT_EMAIL_BOXES=999999999,OPT_EMAIL_GROUPS=999999999,OPT_FTP_ACCOUNTS=999999999,OPT_MYSQL_DBS=999999999,OPT_MYSQL_DB_USERS=999999999,OPT_POINTER_DOMAINS=999999999,OPT_SLAVE_DOMAINS=999999999,OPT_SUBDOMAINS=999999999,OPT_BACKUP=1,OPT_CGI_ACCESS=1,OPT_CRONTAB=1,OPT_DNS_RECORDS=1,OPT_SSL=1,OPT_BURSTABLE=1,OPT_SAVE_XFER_LOGS=1,’,
’is_default’ => 0,
),
1 =>
array (
’id’ => ’9’,
’name’ => ’fifteens’,
’options’ => ’OPT_STORAGE=15,OPT_BANDWIDTH=15,OPT_EMAIL_ALIASES=15,OPT_EMAIL_AUTORESPONDERS=15,OPT_EMAIL_BOXES=15,OPT_EMAIL_GROUPS=15,OPT_FTP_ACCOUNTS=15,OPT_MYSQL_DBS=15,OPT_MYSQL_DB_USERS=15,OPT_POINTER_DOMAINS=15,OPT_SLAVE_DOMAINS=15,OPT_SUBDOMAINS=15,OPT_BACKUP=1,OPT_CGI_ACCESS=1,OPT_CRONTAB=1,OPT_DNS_RECORDS=1,OPT_SSL=1,OPT_BURSTABLE=1,OPT_SAVE_XFER_LOGS=1,’,
’is_default’ => 0,
),
),
)

46 Controller: /nodeworx/plugins

Required Permissions "PLUGINS"
Action: edit
Added in version 4.7.0-339
Description Edit a plugin.
Input Parameters
Name Type Notes Required?
plugin_name string Example Values
simplescripts, auto-enable-shell-account, eventhooks, softaculous, autoset-spamprefs, buddyns, catchall-account-option, cloudflare, disable-local-delivery, dnsme, domain-email-create, external-nfs-quota, hello, history, lets-encrypt, license-api, litespeed, r1soft
Yes
status 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: listPlugins
Added in version 4.8.0-393
Description Get list of plugins.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’name’ => ’simplescripts’,
’label’ => ’Simple Scripts’,
’desc’ => ’SimpleScripts enables one-click management (installs, upgrades, imports of manual installations, uninstalls, and backup restorations) of the Web\’s top applications, including Wordpress, Joomla, Roundcube, and lots more.’,
’status’ => true,
’cat’ => ’##LG_SCRIPT_INSTALLERS##’,
’qh’ => ’SimpleScripts provides all of the Web\’s top applications to your customers with absolutely no maintenance required on your part. What\’s more, you can offer SimpleScripts to your customers free of charge! Visit <a href=\’http://www.simplescripts.com\’ target=\’_blank\’>www.simplescripts.com</a> to learn more.’,
’error’ => ’’,
),
1 =>
array (
’name’ => ’softaculous’,
’label’ => ’Softaculous’,
’desc’ => ’Softaculous is a fast, well designed auto installer, and it installs all scripts in just one step’,
’status’ => false,
’cat’ => ’##LG_SCRIPT_INSTALLERS##’,
’qh’ => ’From <a href=\’http://www.softaculous.com\’ target=\’_blank\’>softaculous.com</a><br><i>Softaculous is a great Auto Installer having 104 great scripts and we are still adding more. Softaculous is ideal for Web Hosting companies and it could give a significant boost to your sales. These scripts cover most of the uses a customer could ever have. We have covered a wide array of Categories so that everyone could find the required script one would need to power their Web Site. The best part is we keep on adding new scripts which we know will satisfy the needs of a User.</i> ’,
’error’ => ’’,
),
2 =>
array (
’name’ => ’r1soft’,
’label’ => ’R1Soft CDP Access’,
’desc’ => ’R1Soft Backup Siteworx Integration’,
’status’ => false,
’cat’ => ’##LG_BACKUP_RESTORE##’,
’qh’ => ’This plugin allows the SiteWorx user to automatically login to their account on an R1Soft CDP Server. By default, all SiteWorx users have access. Access can be revoked on a per SiteWorx account basis by editing the SiteWorx package of the account in question, or at SiteWorx account creation time. This plugin requires the R1Soft Agent installed on the interworx server.’,
’error’ => ’’,
),
),
)
Action: queryEdit
Added in version 5.1.0-838
Description Displays the information available to the action "edit".
Input Parameters
Name Type Notes Required?
plugin_name string Example Values
simplescripts, auto-enable-shell-account, eventhooks, softaculous, autoset-spamprefs, buddyns, catchall-account-option, cloudflare, disable-local-delivery, dnsme, domain-email-create, external-nfs-quota, hello, history, lets-encrypt, license-api, litespeed, r1soft
Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’name’ => ’Simple Scripts’,
’description’ => ’SimpleScripts enables one-click management (installs, upgrades, imports of manual installations, uninstalls, and backup restorations) of the Web\’s top applications, including Wordpress, Joomla, Roundcube, and lots more.’,
’status’ => ’1’,
’plugin_name’ => ’simplescripts’,
),
)

47 Controller: /nodeworx/reseller

Required Permissions "RESELLER"
Action: add
Added in version 4.7.0-339
Description Add a new reseller account.
Input Parameters
Name Type Notes Required?
nickname string No*
email string No*
password string Yes
confirm_password string Help Entry
Confirm the password field by providing it again. Must match the password provided.
Yes
language string Example Values
pl, de, ru, it, tr, en-us, hu, sv, sk, es, zh, da, nl, fr, cs, pt
Example Default Value
en-us
No*
theme string Example Values
blue_steel, calliope, coolfreshness, heliotrope, interstate, interworx, nexcess, vanillaice
Example Default Value
calliope
No*
menu_style string Example Values
big, small
Example Default Value
big
No*
billing_day integer Help Entry
The billing day is the day of the month (1-31) that this reseller’s monthly bandwidth calculation will start back at 0.
Example Values
1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31
Example Default Value
1
No*
status string Example Values
active, inactive
Yes
packagetemplate string Help Entry
A package template is a blueprint for the package to setup. You do not have to use a package template, but it is often easier to use one so you do not have to specify all options every time you setup a SiteWorx account.
Example Values
, Package By Test
No
create_package integer Example Values
1
No
new_package_name string No
RSL_OPT_STORAGE double Description
Megabytes
Help Entry
The amount of storage allocated to this reseller
Yes
RSL_OPT_BANDWIDTH double Description
Gigabytes / Month
Help Entry
The amount of bandwidth per month allocated to this reseller
Yes
RSL_OPT_EMAIL_ALIASES integer Help Entry
The number of e-mail aliases (often called e-mail forwards) allowed across all accounts owned by this reseller
Yes
RSL_OPT_EMAIL_AUTORESPONDERS integer Help Entry
The number of e-mail autoresponders, also called robots, allowed across all accounts owned by this reseller
Yes
RSL_OPT_EMAIL_BOXES integer Help Entry
The number of POP3/IMAP e-mail boxes allowed across all accounts owned by this reseller
Yes
RSL_OPT_EMAIL_GROUPS integer Help Entry
The number of group e-mail (aliases that send to multiple recipients) accounts allowed across all accounts owned by this reseller
Yes
RSL_OPT_FTP_ACCOUNTS integer Help Entry
The number of FTP accounts allowed across all accounts owned by this reseller
Yes
RSL_OPT_MYSQL_DBS integer Help Entry
The number of MySQL databases allowed across all accounts owned by this reseller
Yes
RSL_OPT_MYSQL_DB_USERS integer Help Entry
The number of MySQL users allowed across all accounts owned by this reseller
Yes
RSL_OPT_POINTER_DOMAINS integer Help Entry
The number of pointer domains allowed across all accounts owned by this reseller
Yes
RSL_OPT_SITEWORX_ACCOUNTS integer Help Entry
The number of SiteWorx accounts this reseller can create
Yes
RSL_OPT_SLAVE_DOMAINS integer Help Entry
The number of secondary domains allowed across all accounts owned by this reseller
Yes
RSL_OPT_SUBDOMAINS integer Help Entry
The number of subdomains allowed across all accounts owned by this reseller
Yes
RSL_OPT_OVERSELL_STORAGE integer Help Entry
With storage overselling enabled, the reseller can allocate more storage to the SiteWorx accounts than is technically allowed by the Storage Space allowance for the reseller account.
Example Values
1, 0
Example Default Value
1
No*
RSL_OPT_OVERSELL_BANDWIDTH integer Help Entry
With bandwidth overselling enabled, the reseller can allocate more bandwidth to the SiteWorx accounts than is technically allowed by the Bandwidth allowance for the reseller account.
Example Values
1, 0
Example Default Value
1
No*
RSL_OPT_THEMES integer Help Entry
Allow users to upload custom interface themes.
Example Values
1, 0
Example Default Value
0
No*
ipv4 struct (string) Example Values
10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104
No*
ipv6 struct (string) Example Values
2001:db8::d:1101
No
ipv6_pool struct (string) Help Entry
IPv6 Pools allow resellers to assign Pools to their SiteWorx accounts, which in turn assign IPv6 addresses to domains.
Example Values
dead::/64, dead::/24
No
database_servers struct (string) Help Entry
Select the database server from the list that you would like to use.
Example Values
localhost
Example Default Value
["localhost"]
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: addIp
Added in version 5.0.14-579
Description Adds ips to the list of available IPs for a Reseller account.
Input Parameters
Name Type Notes Required?
reseller_id integer Yes
Action: delete
Added in version 4.7.0-339
Description Delete a reseller account.
Input Parameters
Name Type Notes Required?
reseller_id struct (integer) Yes
Action: edit
Added in version 4.7.0-339
Description Edit a reseller account.
Input Parameters
Name Type Notes Required?
reseller_id integer Yes
nickname string Example Default Value
Reseller Nickname
No*
email string Example Default Value
reseller@interworx.com
No*
password string No
confirm_password string Help Entry
Confirm the password field by providing it again. Must match the password provided.
No
language string Example Values
pl, de, ru, it, tr, en-us, hu, sv, sk, es, zh, da, nl, fr, cs, pt
Example Default Value
en-us
No*
theme string Example Values
blue_steel, calliope, coolfreshness, heliotrope, interstate, interworx, nexcess, vanillaice
Example Default Value
interworx
No*
menu_style string Example Values
big, small
Example Default Value
small
No*
billing_day integer Help Entry
The billing day is the day of the month (1-31) that this reseller’s monthly bandwidth calculation will start back at 0.
Example Values
1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31
Example Default Value
1
No*
status string Example Values
active, inactive
Example Default Value
active
No*
cascade-status integer Example Values
1, 0
Example Default Value
0
No*
packagetemplate string Help Entry
A package template is a blueprint for the package to setup. You do not have to use a package template, but it is often easier to use one so you do not have to specify all options every time you setup a SiteWorx account.
Example Values
, Package By Test
No
RSL_OPT_STORAGE double Description
Megabytes
Help Entry
The amount of storage allocated to this reseller
Example Default Value
999999999
No*
RSL_OPT_BANDWIDTH double Description
Gigabytes / Month
Help Entry
The amount of bandwidth per month allocated to this reseller
Example Default Value
999999999
No*
RSL_OPT_EMAIL_ALIASES integer Help Entry
The number of e-mail aliases (often called e-mail forwards) allowed across all accounts owned by this reseller
Example Default Value
999999999
No*
RSL_OPT_EMAIL_AUTORESPONDERS integer Help Entry
The number of e-mail autoresponders, also called robots, allowed across all accounts owned by this reseller
Example Default Value
999999999
No*
RSL_OPT_EMAIL_BOXES integer Help Entry
The number of POP3/IMAP e-mail boxes allowed across all accounts owned by this reseller
Example Default Value
999999999
No*
RSL_OPT_EMAIL_GROUPS integer Help Entry
The number of group e-mail (aliases that send to multiple recipients) accounts allowed across all accounts owned by this reseller
Example Default Value
999999999
No*
RSL_OPT_FTP_ACCOUNTS integer Help Entry
The number of FTP accounts allowed across all accounts owned by this reseller
Example Default Value
999999999
No*
RSL_OPT_MYSQL_DBS integer Help Entry
The number of MySQL databases allowed across all accounts owned by this reseller
Example Default Value
999999999
No*
RSL_OPT_MYSQL_DB_USERS integer Help Entry
The number of MySQL users allowed across all accounts owned by this reseller
Example Default Value
999999999
No*
RSL_OPT_POINTER_DOMAINS integer Help Entry
The number of pointer domains allowed across all accounts owned by this reseller
Example Default Value
999999999
No*
RSL_OPT_SITEWORX_ACCOUNTS integer Help Entry
The number of SiteWorx accounts this reseller can create
Example Default Value
999999999
No*
RSL_OPT_SLAVE_DOMAINS integer Help Entry
The number of secondary domains allowed across all accounts owned by this reseller
Example Default Value
999999999
No*
RSL_OPT_SUBDOMAINS integer Help Entry
The number of subdomains allowed across all accounts owned by this reseller
Example Default Value
999999999
No*
RSL_OPT_OVERSELL_STORAGE integer Description
Megabytes
Help Entry
With storage overselling enabled, the reseller can allocate more storage to the SiteWorx accounts than is technically allowed by the Storage Space allowance for the reseller account.
Example Values
1, 0
Example Default Value
1
No*
RSL_OPT_OVERSELL_BANDWIDTH integer Description
Gigabytes / Month
Help Entry
With bandwidth overselling enabled, the reseller can allocate more bandwidth to the SiteWorx accounts than is technically allowed by the Bandwidth allowance for the reseller account.
Example Values
1, 0
Example Default Value
1
No*
RSL_OPT_THEMES integer Help Entry
Allow users to upload custom interface themes.
Example Values
1, 0
Example Default Value
1
No*
database_servers struct (string) Help Entry
Select the database server from the list that you would like to use.
Example Values
localhost
Example Default Value
["localhost"]
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: editIPv6Pools
Added in version 5.0.14-579
Description Change IPv6 Pools the reseller has access to.
Input Parameters
Name Type Notes Required?
reseller_id integer Yes
ipv6_pool struct (string) Help Entry
IPv6 Pools allow resellers to assign Pools to their SiteWorx accounts, which in turn assign IPv6 addresses to domains.
Example Values
dead::/64, dead::/24
Example Default Value
["dead::\/24","dead::\/64"]
No
Action: listDeletableIds
Added in version 4.7.0-339
Description List deletable reseller accounts by id.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
0 => ’16’,
1 => ’Reseller Nickname (reseller@interworx.com)’,
),
),
)
Action: listEditableIds
Added in version 4.7.0-339
Description List editable reseller accounts by id.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
0 => ’16’,
1 => ’Reseller Nickname (reseller@interworx.com)’,
),
),
)
Action: listIds
Added in version 4.7.0-339
Description List reseller accounts by id.
Warning This action has been deprecated as of version 4.8.0-393. 2011-01-24 use listResellersAction
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
0 => ’1’,
1 => ’Server Admin (nodeworx_user@example.com)’,
),
1 =>
array (
0 => ’16’,
1 => ’Reseller Nickname (reseller@interworx.com)’,
),
),
)
Action: listResellers
Added in version 4.8.0-393
Description List all resellers.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’reseller_id’ => ’1’,
’email’ => ’nodeworx_user@example.com’,
’nickname’ => ’Server Admin’,
’status’ => ’active’,
’max_bandwidth’ => ’999999999’,
’max_storage’ => ’999999999’,
’max_accounts’ => ’999999999’,
’bandwidth’ => ’0’,
’accounts’ => ’1’,
’storage’ => ’0’,
),
1 =>
array (
’reseller_id’ => ’16’,
’email’ => ’reseller@interworx.com’,
’nickname’ => ’Reseller Nickname’,
’status’ => ’active’,
’max_bandwidth’ => ’999999999’,
’max_storage’ => ’999999999’,
’max_accounts’ => ’999999999’,
’bandwidth’ => ’0’,
’accounts’ => ’0’,
’storage’ => ’0’,
),
),
)
Action: queryAvailableIps
Added in version 5.0.14-579
Description Displays a payload of IPs available to a reseller.
Input Parameters
Name Type Notes Required?
reseller_id integer No*
* indicates that it’s actually required, but probably already has a valid default value
Action: queryDomains
Added in version 5.1.0-941
Description Show domains on a reseller.
Input Parameters
Name Type Notes Required?
reseller_id integer No*
* indicates that it’s actually required, but probably already has a valid default value
Action: queryEdit
Added in version 5.1.0-838
Description Displays the information available to the action "edit".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’nickname’ => ’Reseller Nickname’,
’email’ => ’reseller@interworx.com’,
’password’ => NULL,
’confirm_password’ => NULL,
’language’ => ’en-us’,
’theme’ => ’interworx’,
’menu_style’ => ’small’,
’billing_day’ => ’1’,
’status’ => ’active’,
’cascade-status’ => ’0’,
’packagetemplate’ => NULL,
’RSL_OPT_STORAGE’ => ’999999999’,
’RSL_OPT_BANDWIDTH’ => ’999999999’,
’RSL_OPT_EMAIL_ALIASES’ => ’999999999’,
’RSL_OPT_EMAIL_AUTORESPONDERS’ => ’999999999’,
’RSL_OPT_EMAIL_BOXES’ => ’999999999’,
’RSL_OPT_EMAIL_GROUPS’ => ’999999999’,
’RSL_OPT_FTP_ACCOUNTS’ => ’999999999’,
’RSL_OPT_MYSQL_DBS’ => ’999999999’,
’RSL_OPT_MYSQL_DB_USERS’ => ’999999999’,
’RSL_OPT_POINTER_DOMAINS’ => ’999999999’,
’RSL_OPT_SITEWORX_ACCOUNTS’ => ’999999999’,
’RSL_OPT_SLAVE_DOMAINS’ => ’999999999’,
’RSL_OPT_SUBDOMAINS’ => ’999999999’,
’RSL_OPT_OVERSELL_STORAGE’ => ’1’,
’RSL_OPT_OVERSELL_BANDWIDTH’ => ’1’,
’RSL_OPT_THEMES’ => ’1’,
’database_servers’ =>
array (
0 => ’localhost’,
),
’reseller_id’ => ’16’,
’options’ =>
array (
’LG_RSL_OPT_STORAGE’ => ’999999999’,
’LG_RSL_OPT_OVERSELL_STORAGE’ => ’1’,
’LG_RSL_OPT_BANDWIDTH’ => ’999999999’,
’LG_RSL_OPT_OVERSELL_BANDWIDTH’ => ’1’,
’LG_RSL_OPT_EMAIL_ALIASES’ => ’999999999’,
’LG_RSL_OPT_EMAIL_AUTORESPONDERS’ => ’999999999’,
’LG_RSL_OPT_EMAIL_BOXES’ => ’999999999’,
’LG_RSL_OPT_EMAIL_GROUPS’ => ’999999999’,
’LG_RSL_OPT_FTP_ACCOUNTS’ => ’999999999’,
’LG_RSL_OPT_MYSQL_DBS’ => ’999999999’,
’LG_RSL_OPT_MYSQL_DB_USERS’ => ’999999999’,
’LG_RSL_OPT_POINTER_DOMAINS’ => ’999999999’,
’LG_RSL_OPT_SITEWORX_ACCOUNTS’ => ’999999999’,
’LG_RSL_OPT_SLAVE_DOMAINS’ => ’999999999’,
’LG_RSL_OPT_SUBDOMAINS’ => ’999999999’,
’LG_RSL_OPT_THEMES’ => ’1’,
),
’password1’ => NULL,
),
)
Action: queryEditIPv6Pools
Added in version 5.1.0-838
Description Displays the information available to the action "editIPv6Pools".
Input Parameters
Name Type Notes Required?
reseller_id integer Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’ipv6_pool’ =>
array (
0 => ’dead::/24’,
1 => ’dead::/64’,
),
’reseller_id’ => ’1’,
),
)
Action: queryResellerBandwidth
Added in version 4.9.0-427
Description Query Reseller Account bandwidth usage data for any billing period.
Input Parameters
Name Type Notes Required?
resellers struct (string) Help Entry
Select resellers to view bandwidth data for. Selecting none is the same as selecting all.
Example Values
reseller@interworx.com
No
timestamp integer Help Entry
A Unix Timestamp to identify the billing period from which the bandwidth data will be shown. If blank, defaults to the current time.
No
Action: queryResellerDetails
Added in version 4.8.0-393
Description Query reseller account details.
Input Parameters
Name Type Notes Required?
reseller string Example Values
reseller@interworx.com
Yes
Action: querySiteworxAccounts
Added in version 5.1.0-941
Description Show siteworx accounts owned by a reseller account.
Input Parameters
Name Type Notes Required?
reseller_id integer No*
* indicates that it’s actually required, but probably already has a valid default value
Action: removeIp
Added in version 5.0.14-579
Description Remove access to an IP from a reseller.
Input Parameters
Name Type Notes Required?
reseller_id integer Yes
ip struct (string) Example Values
10.1.15.101
Yes

48 Controller: /nodeworx/reseller/bandwidthhistory

Action: listBandwidth
Added in version 4.8.0-393
Description List the bandwidth history overview.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’periodstart’ => ’1506830400’,
’periodend’ => ’1509508799’,
’http’ => 0,
’ftp’ => 0,
’total’ => 0,
),
1 =>
array (
’periodstart’ => ’1504238400’,
’periodend’ => ’1506830399’,
’http’ => 0,
’ftp’ => 0,
’total’ => 0,
),
2 =>
array (
’periodstart’ => ’1501560000’,
’periodend’ => ’1504238399’,
’http’ => 0,
’ftp’ => 0,
’total’ => 0,
),
),
)
Action: queryBandwidth
Added in version 4.8.0-393
Description Search for bandwidth history for a given reseller.
Input Parameters
Name Type Notes Required?
nodeworx_id integer No
Action: queryBandwidthDetails
Added in version 4.8.0-393
Description Search for reseller bandwidth details for a given period.
Input Parameters
Name Type Notes Required?
nodeworx_id integer No
period integer Yes

49 Controller: /nodeworx/reseller/packages

Required Permissions "RESELLER"
Action: add
Added in version 4.7.0-339
Description Add a Reseller Package.
Input Parameters
Name Type Notes Required?
package_name string Yes
RSL_OPT_STORAGE double Description
Megabytes
Help Entry
The amount of storage allocated to this reseller
Yes
RSL_OPT_OVERSELL_STORAGE integer Description
Megabytes
Help Entry
With storage overselling enabled, the reseller can allocate more storage to the SiteWorx accounts than is technically allowed by the Storage Space allowance for the reseller account.
Example Values
1, 0
Yes
RSL_OPT_BANDWIDTH double Description
Gigabytes / Month
Help Entry
The amount of bandwidth per month allocated to this reseller
Yes
RSL_OPT_OVERSELL_BANDWIDTH integer Description
Gigabytes / Month
Help Entry
With bandwidth overselling enabled, the reseller can allocate more bandwidth to the SiteWorx accounts than is technically allowed by the Bandwidth allowance for the reseller account.
Example Values
1, 0
Yes
RSL_OPT_EMAIL_ALIASES integer Help Entry
The number of e-mail aliases (often called e-mail forwards) allowed across all accounts owned by this reseller
Yes
RSL_OPT_EMAIL_AUTORESPONDERS integer Help Entry
The number of e-mail autoresponders, also called robots, allowed across all accounts owned by this reseller
Yes
RSL_OPT_EMAIL_BOXES integer Help Entry
The number of POP3/IMAP e-mail boxes allowed across all accounts owned by this reseller
Yes
RSL_OPT_EMAIL_GROUPS integer Help Entry
The number of group e-mail (aliases that send to multiple recipients) accounts allowed across all accounts owned by this reseller
Yes
RSL_OPT_FTP_ACCOUNTS integer Help Entry
The number of FTP accounts allowed across all accounts owned by this reseller
Yes
RSL_OPT_MYSQL_DBS integer Help Entry
The number of MySQL databases allowed across all accounts owned by this reseller
Yes
RSL_OPT_MYSQL_DB_USERS integer Help Entry
The number of MySQL users allowed across all accounts owned by this reseller
Yes
RSL_OPT_POINTER_DOMAINS integer Help Entry
The number of pointer domains allowed across all accounts owned by this reseller
Yes
RSL_OPT_SITEWORX_ACCOUNTS integer Help Entry
The number of SiteWorx accounts this reseller can create
Yes
RSL_OPT_SLAVE_DOMAINS integer Help Entry
The number of secondary domains allowed across all accounts owned by this reseller
Yes
RSL_OPT_SUBDOMAINS integer Help Entry
The number of subdomains allowed across all accounts owned by this reseller
Yes
RSL_OPT_THEMES integer Help Entry
Allow users to upload custom interface themes.
Example Values
1, 0
Yes
Action: backup
Added in version 4.8.3-414
Description Backup a reseller package.
Input Parameters
Name Type Notes Required?
id struct (integer) Yes
Action: delete
Added in version 4.7.0-339
Description Delete a reseller package.
Input Parameters
Name Type Notes Required?
id struct (integer) Yes
Action: edit
Added in version 4.7.0-339
Description Edit an existing Reseller Package.
Input Parameters
Name Type Notes Required?
id integer Yes
package_name string Example Default Value
Package By Test
No*
RSL_OPT_STORAGE double Description
Megabytes
Help Entry
The amount of storage allocated to this reseller
Example Default Value
999999999
No*
RSL_OPT_OVERSELL_STORAGE integer Description
Megabytes
Help Entry
With storage overselling enabled, the reseller can allocate more storage to the SiteWorx accounts than is technically allowed by the Storage Space allowance for the reseller account.
Example Values
1, 0
Example Default Value
1
No*
RSL_OPT_BANDWIDTH double Description
Gigabytes / Month
Help Entry
The amount of bandwidth per month allocated to this reseller
Example Default Value
999999999
No*
RSL_OPT_OVERSELL_BANDWIDTH integer Description
Gigabytes / Month
Help Entry
With bandwidth overselling enabled, the reseller can allocate more bandwidth to the SiteWorx accounts than is technically allowed by the Bandwidth allowance for the reseller account.
Example Values
1, 0
Example Default Value
1
No*
RSL_OPT_EMAIL_ALIASES integer Help Entry
The number of e-mail aliases (often called e-mail forwards) allowed across all accounts owned by this reseller
Example Default Value
999999999
No*
RSL_OPT_EMAIL_AUTORESPONDERS integer Help Entry
The number of e-mail autoresponders, also called robots, allowed across all accounts owned by this reseller
Example Default Value
999999999
No*
RSL_OPT_EMAIL_BOXES integer Help Entry
The number of POP3/IMAP e-mail boxes allowed across all accounts owned by this reseller
Example Default Value
999999999
No*
RSL_OPT_EMAIL_GROUPS integer Help Entry
The number of group e-mail (aliases that send to multiple recipients) accounts allowed across all accounts owned by this reseller
Example Default Value
999999999
No*
RSL_OPT_FTP_ACCOUNTS integer Help Entry
The number of FTP accounts allowed across all accounts owned by this reseller
Example Default Value
999999999
No*
RSL_OPT_MYSQL_DBS integer Help Entry
The number of MySQL databases allowed across all accounts owned by this reseller
Example Default Value
999999999
No*
RSL_OPT_MYSQL_DB_USERS integer Help Entry
The number of MySQL users allowed across all accounts owned by this reseller
Example Default Value
999999999
No*
RSL_OPT_POINTER_DOMAINS integer Help Entry
The number of pointer domains allowed across all accounts owned by this reseller
Example Default Value
999999999
No*
RSL_OPT_SITEWORX_ACCOUNTS integer Help Entry
The number of SiteWorx accounts this reseller can create
Example Default Value
999999999
No*
RSL_OPT_SLAVE_DOMAINS integer Help Entry
The number of secondary domains allowed across all accounts owned by this reseller
Example Default Value
999999999
No*
RSL_OPT_SUBDOMAINS integer Help Entry
The number of subdomains allowed across all accounts owned by this reseller
Example Default Value
999999999
No*
RSL_OPT_THEMES integer Help Entry
Allow users to upload custom interface themes.
Example Values
1, 0
Example Default Value
1
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: import
Added in version 4.8.3-414
Description Import a reseller package.
Input Parameters
Name Type Notes Required?
package_file string Yes
overwrite integer Example Values
1
No
Action: listDetails
Added in version 4.7.0-339
Description Lists Reseller package details.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’id’ => ’17’,
’name’ => ’Package By Test’,
’RSL_OPT_STORAGE’ => 999999999,
’RSL_OPT_OVERSELL_STORAGE’ => true,
’RSL_OPT_BANDWIDTH’ => 999999999,
’RSL_OPT_OVERSELL_BANDWIDTH’ => true,
’RSL_OPT_EMAIL_ALIASES’ => 999999999,
’RSL_OPT_EMAIL_AUTORESPONDERS’ => 999999999,
’RSL_OPT_EMAIL_BOXES’ => 999999999,
’RSL_OPT_EMAIL_GROUPS’ => 999999999,
’RSL_OPT_FTP_ACCOUNTS’ => 999999999,
’RSL_OPT_MYSQL_DBS’ => 999999999,
’RSL_OPT_MYSQL_DB_USERS’ => 999999999,
’RSL_OPT_POINTER_DOMAINS’ => 999999999,
’RSL_OPT_SITEWORX_ACCOUNTS’ => 999999999,
’RSL_OPT_SLAVE_DOMAINS’ => 999999999,
’RSL_OPT_SUBDOMAINS’ => 999999999,
’RSL_OPT_THEMES’ => true,
),
),
)
Action: listIds
Added in version 4.7.0-339
Description List reseller packages by id.
Warning This action has been deprecated as of version 4.8.0-393. 2011-01-25 Use listResellerPackages instead.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
0 => ’17’,
1 => ’Package By Test’,
),
),
)
Action: listResellerPackages
Added in version 4.8.0-393
Description List reseller packages.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’id’ => ’17’,
’name’ => ’Package By Test’,
’options’ => ’RSL_OPT_STORAGE=999999999,RSL_OPT_OVERSELL_STORAGE=1,RSL_OPT_BANDWIDTH=999999999,RSL_OPT_OVERSELL_BANDWIDTH=1,RSL_OPT_EMAIL_ALIASES=999999999,RSL_OPT_EMAIL_AUTORESPONDERS=999999999,RSL_OPT_EMAIL_BOXES=999999999,RSL_OPT_EMAIL_GROUPS=999999999,RSL_OPT_FTP_ACCOUNTS=999999999,RSL_OPT_MYSQL_DBS=999999999,RSL_OPT_MYSQL_DB_USERS=999999999,RSL_OPT_POINTER_DOMAINS=999999999,RSL_OPT_SITEWORX_ACCOUNTS=999999999,RSL_OPT_SLAVE_DOMAINS=999999999,RSL_OPT_SUBDOMAINS=999999999,RSL_OPT_THEMES=1,’,
),
),
)
Action: queryEdit
Added in version 5.1.0-838
Description Displays the information available to the action "edit".
Input Parameters
Name Type Notes Required?
id integer Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’package_name’ => ’Package By Test’,
’RSL_OPT_STORAGE’ => ’999999999’,
’RSL_OPT_OVERSELL_STORAGE’ => ’1’,
’RSL_OPT_BANDWIDTH’ => ’999999999’,
’RSL_OPT_OVERSELL_BANDWIDTH’ => ’1’,
’RSL_OPT_EMAIL_ALIASES’ => ’999999999’,
’RSL_OPT_EMAIL_AUTORESPONDERS’ => ’999999999’,
’RSL_OPT_EMAIL_BOXES’ => ’999999999’,
’RSL_OPT_EMAIL_GROUPS’ => ’999999999’,
’RSL_OPT_FTP_ACCOUNTS’ => ’999999999’,
’RSL_OPT_MYSQL_DBS’ => ’999999999’,
’RSL_OPT_MYSQL_DB_USERS’ => ’999999999’,
’RSL_OPT_POINTER_DOMAINS’ => ’999999999’,
’RSL_OPT_SITEWORX_ACCOUNTS’ => ’999999999’,
’RSL_OPT_SLAVE_DOMAINS’ => ’999999999’,
’RSL_OPT_SUBDOMAINS’ => ’999999999’,
’RSL_OPT_THEMES’ => ’1’,
’id’ => ’17’,
),
)

50 Controller: /nodeworx/settings

Required Permissions "SETTINGS"
Action: edit
Added in version 4.7.0-339
Description Edit misc interworx settings.
Input Parameters
Name Type Notes Required?
iworx.license_key string Description
Changing this to an invalid key will lock you out of NodeWorx. Be very sure of what you are doing.
Example Default Value
INTERWORX_APIDOC2
No*
iworx_debug integer Description
This option will enable more detailed error messages.
Help Entry
####
Example Values
1, 0
Example Default Value
1
No*
iworx_debug_templates integer Description
This option turns on a pop-up window with information available to template designers.
Example Values
1, 0
Example Default Value
0
No*
form_xhr_validate integer Description
When enabled, forms are validated line-by-line as the user inputs data.
Example Values
1, 0
Example Default Value
1
No*
form_check_all integer Description
Sets the threshold for showing "check all" helpers for groups of checkboxes
Example Default Value
7
No*
form_xhr_log_reload integer Description
Sets how many seconds the log-viewer forms will wait until refreshing the log. Default: 5
Example Default Value
5
No*
iworx_default_timezone string Description
The global timezone to be used within InterWorx.
Example Values
Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Tripoli, ...
Example Default Value
America/New_York
No*
constants_date_format string Description
Compatible with PHP’s strftime() function. Controls the format of displayed dates in the interface. Default is %Y-%m-%d.
Example Default Value
%Y-%m-%d
No*
constants_time_format string Description
Compatible with PHPs strftime() function. Controls the format of displayed times in the interface. Default is %H:%M:%S.
Example Default Value
%H:%M:%S
No*
constants_datetime_format string Description
Compatible with PHP’s strftime() function. Controls the format of displayed dates with times in the interface. Default is %Y-%m-%d %H:%M:%S.
Example Default Value
%Y-%m-%d %H:%M:%S
No*
thousands_sep string Description
The character that will be used as the thousands separator.
Example Values
comma, period, space
Example Default Value
comma
No*
constants_dec_point string Description
The character that will be used as the decimal point.
Example Default Value
.
No*
qmail_use_senderip integer Description
When Sender IP is enabled, mail will be sent from the SiteWorx account’s IP address.
Example Values
1, 0
Example Default Value
1
No*
mail_default_from string Description
Email address used as the sender for notification emails
Example Default Value
selenium@interworx.com
No*
mail_default_from_name string Description
Name used as the sender for notification emails
Example Default Value
NodeWorx Server Manager
No*
horde_enabled integer Description
Display Horde in the webmail selector. NOTE: This does not uninstall the interworx-horde RPM
Example Values
1, 0
Example Default Value
1
No*
roundcube_enabled integer Description
Display Roundcube in the webmail selector. NOTE: This does not uninstall the interworx-roundcube RPM’
Example Values
1, 0
Example Default Value
1
No*
squirrelmail_enabled integer Description
Display SquirrelMail in the webmail selector. NOTE: this does not uninstall the interworx-squirrelmail RPM
Example Values
1, 0
Example Default Value
1
No*
webmail_default string Description
The webmail client that is pre-selected by default at /webmail.
Example Values
horde, roundcube, squirrelmail
Example Default Value
horde
No*
nodeworx_login_autocomplete integer Description
Allow autocomplete on the NodeWorx login form.
Example Values
1, 0
Example Default Value
1
No*
iworx.templates_nodeworx string Description
Theme to use before users are logged into NodeWorx.
Example Values
blue_steel, calliope, coolfreshness, heliotrope, interstate, interworx, nexcess, vanillaice
Example Default Value
heliotrope
No*
iworx.language_nodeworx string Description
Language to use before users are logged into NodeWorx.
Example Values
pl, de, ru, it, tr, en-us, hu, sv, sk, es, zh, da, nl, fr, cs, pt
Example Default Value
en-us
No*
support.url_user string Description
Link to use for NodeWorx support. NOTE: this may be overridden in custom templates.
Example Default Value
http://www.interworx.com/support/faq/topics/nodeworx-faq/
No*
nodeworx_siteworx_accounts_perpage integer Example Default Value
20
No*
siteworx_login_autocomplete integer Description
Allow autocomplete on the SiteWorx login form.
Example Values
1, 0
Example Default Value
1
No*
iworx.templates_siteworx string Description
Theme to use before users are logged into SiteWorx.
Example Values
blue_steel, calliope, coolfreshness, heliotrope, interstate, interworx, nexcess, vanillaice
Example Default Value
heliotrope
No*
iworx.language_siteworx string Description
Language to use before users are logged into SiteWorx.
Example Values
pl, de, ru, it, tr, en-us, hu, sv, sk, es, zh, da, nl, fr, cs, pt
Example Default Value
en-us
No*
support.url_siteworx_user string Description
Link to use for SiteWorx support. NOTE: this may be overridden in custom templates.
Example Default Value
http://www.interworx.com/support/faq/topics/siteworx-faq/
No*
siteworx_show_box_size integer Description
Calculates the disk storage taken by each mailbox. This can take a long time, especially in domains with many email boxes.
Help Entry
Calculates the disk storage taken by each mailbox. This can take a long time, especially in domains with many email boxes.
Example Values
1, 0
Example Default Value
1
No*
siteworx.logs_savexferlogs integer Description
Defines how many days to keep daily transfer logs on SiteWorx accounts before purging them.
Example Default Value
7
No*
siteworx.logs_saveerrlogs integer Description
Defines how many days to keep daily error logs on SiteWorx accounts before purging them.
Example Default Value
7
No*
siteworx_allow_crossaccount_subdomains integer Description
Having subdomains split to their own SiteWorx accounts is desirable in many cases - for example, it allows the subdomain to run under its own Unix User for security. However, a malicious user could create their own Secondary Domain to hijack a subdomain of another account.
Example Values
1, 0
Example Default Value
1
No*
iworx_fileman integer Description
Enable or Disable the control panel file manager server-wide.
Example Values
1, 0
Example Default Value
1
No*
iworx.backup_siteworx_schedule integer Description
If enabled, SiteWorx accounts will be permitted to schedule SiteWorx backups.
Example Values
1, 0
Example Default Value
1
No*
iworx.backup_enable_daily integer Description
If enabled, SiteWorx accounts with the Backup package option enabled will be permitted to schedule daily SiteWorx backups.
Example Values
1, 0
Example Default Value
1
No*
iworx.backup_enable_weekly integer Description
If enabled, SiteWorx accounts with the Backup package option enabled will be permitted to schedule weekly SiteWorx backups.
Example Values
1, 0
Example Default Value
1
No*
iworx.backup_enable_monthly integer Description
If enabled, SiteWorx accounts with the Backup package option enabled will be permitted to schedule monthly SiteWorx backups.
Example Values
1, 0
Example Default Value
1
No*
iworx.backup_use_user_quota integer Description
If enabled, SiteWorx backup storage will apply against the SiteWorx account storage quota.
Example Values
1, 0
Example Default Value
1
No*
iworx.backup_rotate_max integer Description
This number ONLY applies to backups stored in the "default" backup storage location for a given account (/home/user/domain/iworx-backup). Scheduled backups that are transferred via the SCP or FTP transfer mechanisms are NOT rotated.
Help Entry
Indicates the maximum number of backups to keep before removing old backups.
Example Default Value
25
No*
conf.editing_http integer Description
Controls whether the config file can be edited through the web interface
Example Values
1, 0
Example Default Value
1
No*
conf.editing_ftp integer Description
Controls whether the config file can be edited through the web interface
Example Values
1, 0
Example Default Value
1
No*
conf.editing_ssh integer Description
Controls whether the config file can be edited through the web interface
Example Values
1, 0
Example Default Value
1
No*
stats.awstats_enabled integer Description
This globally disables AWStats log analysis.
Example Values
1, 0
Example Default Value
1
No*
stats.analog_enabled integer Description
This globally disables Analog log analysis.
Example Values
1, 0
Example Default Value
1
No*
stats.webalizer_enabled integer Description
This globally disables Webalizer log analysis.
Example Values
1, 0
Example Default Value
1
No*
stats.realtime_mem_chart string Description
Controls the style of the memory graph in the NodeWorx overview page.
Example Values
simple, advanced
Example Default Value
simple
No*
rrd_ping_host string Description
Website used for measuring ping latency.
Example Default Value
yahoo.com
No*
stats.realtime_default_network_interface string Description
This is the default network device used for charts. Updating this value may not show an immediate change: chart images are cached for a short time.
Example Values
eth0, lo
Example Default Value
eth0
No*
apache.file_vhost-base string Description
File to use as the template for creating virtual hosts when creating SiteWorx accounts and secondary domains.
Example Default Value
/home/interworx/etc/vhost-base.conf
No*
apache_sni_enabled integer Description
SNI, or Server Name Indication, allows multiple SSL certificates to be installed on one IP address. For more information, see: http://en.wikipedia.org/wiki/Server_Name_Indication
Example Values
1, 0
Example Default Value
1
No*
iworx.passwords_threshold integer Description
Prevent users from setting passwords below this strength threshold. Common passwords will still be blocked from use.
Example Values
0, 1, 2, 3, 4
Example Default Value
0
No*
iworx.passwords_length integer Description
The minimum allowable length for user passwords.
Example Default Value
6
No
quota_partition string Description
Partition where user home folders reside. Used for calculating storage quotas, etc.
Example Values
/, /dev/shm, /boot
Example Default Value
/
No*
quota_quota-overflow-pct integer Description
The percentage by which a SiteWorx account may temporarily exceed the assigned storage quota.
Example Default Value
25
No*
quota_grace_time integer Description
The amount of time a SiteWorx account may temporarily exceed the assigned storage quota. 604800 = 7 days, 259200 = 3 days, 86400 = 1 day, etc.
Example Default Value
604800
No*
dir_tmp string Description
Directory to use for temporary files.
Example Default Value
/tmp
No*
domain-blacklist struct (string) Description
A list of domains that cannot be created in SiteWorx for security purposes.
Yes
* indicates that it’s actually required, but probably already has a valid default value
Action: queryEdit
Added in version 5.1.0-838
Description Displays the information available to the action "edit".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’iworx_version’ => ’6.0.13’,
’iworx_rpm.release’ => ’6.0.13-1384’,
’iworx.license_key’ => ’INTERWORX_APIDOC2’,
’iworx_debug’ => ’1’,
’iworx_debug_templates’ => ’0’,
’form_xhr_validate’ => ’1’,
’form_check_all’ => ’7’,
’form_xhr_log_reload’ => ’5’,
’iworx_default_timezone’ => ’America/New_York’,
’constants_date_format’ => ’%Y-%m-%d’,
’constants_time_format’ => ’%H:%M:%S’,
’constants_datetime_format’ => ’%Y-%m-%d %H:%M:%S’,
’thousands_sep’ => ’comma’,
’constants_dec_point’ => ’.’,
’qmail_use_senderip’ => ’1’,
’mail_default_from’ => ’selenium@interworx.com’,
’mail_default_from_name’ => ’NodeWorx Server Manager’,
’horde_enabled’ => ’1’,
’roundcube_enabled’ => ’1’,
’squirrelmail_enabled’ => ’1’,
’webmail_default’ => ’horde’,
’nodeworx_login_autocomplete’ => ’1’,
’iworx.templates_nodeworx’ => ’heliotrope’,
’iworx.language_nodeworx’ => ’en-us’,
’support.url_user’ => ’http://www.interworx.com/support/faq/topics/nodeworx-faq/’,
’nodeworx_siteworx_accounts_perpage’ => ’20’,
’siteworx_login_autocomplete’ => ’1’,
’iworx.templates_siteworx’ => ’heliotrope’,
’iworx.language_siteworx’ => ’en-us’,
’support.url_siteworx_user’ => ’http://www.interworx.com/support/faq/topics/siteworx-faq/’,
’siteworx_show_box_size’ => ’1’,
’siteworx.logs_savexferlogs’ => ’7’,
’siteworx.logs_saveerrlogs’ => ’7’,
’siteworx_allow_crossaccount_subdomains’ => ’1’,
’iworx_fileman’ => ’1’,
’iworx.backup_siteworx_schedule’ => ’1’,
’iworx.backup_enable_daily’ => ’1’,
’iworx.backup_enable_weekly’ => ’1’,
’iworx.backup_enable_monthly’ => ’1’,
’iworx.backup_use_user_quota’ => ’1’,
’iworx.backup_rotate_max’ => ’25’,
’conf.editing_http’ => ’1’,
’conf.editing_ftp’ => ’1’,
’conf.editing_ssh’ => ’1’,
’stats.awstats_enabled’ => ’1’,
’stats.analog_enabled’ => ’1’,
’stats.webalizer_enabled’ => ’1’,
’stats.realtime_mem_chart’ => ’simple’,
’rrd_ping_host’ => ’yahoo.com’,
’stats.realtime_default_network_interface’ => ’eth0’,
’apache.file_vhost-base’ => ’/home/interworx/etc/vhost-base.conf’,
’apache_sni_enabled’ => ’1’,
’iworx.passwords_threshold’ => ’0’,
’iworx.passwords_length’ => ’6’,
’quota_partition’ => ’/’,
’quota_quota-overflow-pct’ => ’25’,
’quota_grace_time’ => ’604800’,
’dir_tmp’ => ’/tmp’,
’domain-blacklist’ =>
array (
0 => ’gmail.com’,
1 => ’yahoo.com’,
2 => ’hotmail.com’,
3 => ’gmx.de’,
4 => ’googlemail.com’,
5 => ’mail.ru’,
6 => ’web.de’,
7 => ’live.com’,
8 => ’aol.com’,
9 => ’gmx.net’,
10 => ’yandex.ru2’,
11 => ’me.com’,
12 => ’msn.com’,
13 => ’comcast.net’,
14 => ’hushmail.com’,
15 => ’yahoo.de’,
16 => ’hotmail.co.uk’,
17 => ’lavabit.com’,
18 => ’sbcglobal.net’,
19 => ’safe-mail.net’,
20 => ’ymail.com’,
21 => ’yahoo.co.uk’,
22 => ’mac.com’,
23 => ’qq.com’,
24 => ’gmx.com’,
25 => ’hotmail.de’,
26 => ’ya.ru’,
27 => ’rambler.ru’,
28 => ’o2.pl’,
29 => ’abv.bg’,
30 => ’freenet.de’,
31 => ’mailinator.com’,
32 => ’gmx.at’,
33 => ’cox.net’,
34 => ’rocketmail.com’,
35 => ’bk.ru’,
36 => ’ukr.net’,
37 => ’163.com’,
38 => ’arcor.de’,
39 => ’mail.com’,
40 => ’list.ru’,
41 => ’att.net’,
42 => ’aim.com’,
43 => ’live.co.uk’,
44 => ’inbox.ru’,
45 => ’verizon.net’,
46 => ’126.com’,
47 => ’hush.com’,
48 => ’t-online.de’,
49 => ’free.fr’,
50 => ’shaw.ca’,
51 => ’wp.pl’,
52 => ’hotmail.fr’,
53 => ’yahoo.com.au’,
54 => ’live.de’,
55 => ’yahoo.ca’,
56 => ’btinternet.com’,
57 => ’iki.fi’,
58 => ’hotmail.it’,
59 => ’yahoo.it’,
60 => ’mail.bg’,
61 => ’live.com.au’,
62 => ’fastmail.fm’,
63 => ’yahoo.fr’,
64 => ’seznam.cz’,
65 => ’gmx.ch’,
66 => ’bellsouth.net’,
67 => ’online.de’,
68 => ’live.se’,
69 => ’zoho.com’,
70 => ’tiscali.it’,
71 => ’pobox.com’,
72 => ’nym.hush.com’,
73 => ’i2pmail.org’,
74 => ’earthlink.net’,
75 => ’tut.by’,
76 => ’libero.it’,
77 => ’juno.com’,
78 => ’hush.ai’,
79 => ’snkmail.com’,
80 => ’charter.net’,
81 => ’sina.com’,
82 => ’riseup.net’,
83 => ’centrum.cz’,
84 => ’yahoo.es’,
85 => ’yahoo.com.vn’,
86 => ’yahoo.com.cn’,
87 => ’mit.edu’,
88 => ’live.dk’,
89 => ’live.ca’,
90 => ’inbox.lv’,
91 => ’i.ua’,
92 => ’telus.net’,
93 => ’telia.com’,
94 => ’telenet.be’,
95 => ’optonline.net’,
96 => ’klzlk.com’,
97 => ’yahoo.se’,
98 => ’yahoo.com.ar’,
99 => ’sharedaddy.com’,
100 => ’rochester.rr.com’,
101 => ’prime.gushi.org’,
102 => ’yahoo.com.br’,
103 => ’tlen.pl’,
104 => ’sporktronics.com’,
105 => ’spamgourmet.com’,
106 => ’live.nl’,
107 => ’live.fr’,
108 => ’inbox.com’,
109 => ’hmamail.com’,
110 => ’email.com’,
111 => ’bluewin.ch’,
112 => ’google.com’,
113 => ’excite.com’,
114 => ’address.com’,
115 => ’altavista.net’,
116 => ’netscape.net’,
117 => ’netscape.com’,
118 => ’attracta.com’,
),
),
)

51 Controller: /nodeworx/shell

Required Permissions "SWACCOUNTS"
Action: changeshell
Added in version 4.8.0-393
Description Change the user’s shell.
Input Parameters
Name Type Notes Required?
users struct (string) Example Values
example, nfsnobody, axfrdns
Yes
shell string Example Values
/bin/sh, /bin/bash, /sbin/nologin, /bin/dash, /usr/sbin/jk_chrootsh
Example Default Value
/sbin/nologin
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: disable
Added in version 4.8.0-393
Description Disable the specified shell user.
Input Parameters
Name Type Notes Required?
users struct (string) Example Values
example, nfsnobody, axfrdns
Yes
Action: enable
Added in version 4.8.0-393
Description Enable the specified shell user.
Input Parameters
Name Type Notes Required?
users struct (string) Example Values
example, nfsnobody, axfrdns
Yes
Action: forbiddenUsers
Added in version 4.11.0-456
Description Modify the list of disabled uniqnames.
Input Parameters
Name Type Notes Required?
forbidden_unix_users struct (string) No*
* indicates that it’s actually required, but probably already has a valid default value
Action: listSiteworxUsers
Added in version 4.8.0-393
Description Lists the SiteWorx shell users.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’shell’ => ’/sbin/nologin’,
’home’ => ’/home/example’,
’info’ => ’’,
’gid’ => ’669’,
’uid’ => ’669’,
’x’ => ’x’,
’user’ => ’example’,
’pass’ => ’!!’,
’disabled’ => true,
’siteworx’ => ’example.com’,
’history’ =>
array (
’history’ => false,
’user’ => ’example’,
),
),
),
)
Action: listSystemUsers
Added in version 4.8.0-393
Description Lists the System shell users.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’shell’ => ’/bin/bash’,
’home’ => ’/root’,
’info’ => ’root’,
’gid’ => ’0’,
’uid’ => ’0’,
’x’ => ’x’,
’user’ => ’root’,
’pass’ => ’$6$QOSkvN8d$1b5oSdfeYT68.TijbF.roHKJAM0BeaR4rnAfJ/I.mGwhpX8ayw4jt0pxRXZQLL1eNZ8Qd5jjJpBJD7F8D7R0Q.’,
’disabled’ => false,
’history’ =>
array (
’history’ => true,
’user’ => ’root’,
),
),
1 =>
array (
’shell’ => ’/sbin/nologin’,
’home’ => ’/var/lib/nfs’,
’info’ => ’Anonymous NFS User’,
’gid’ => ’65534’,
’uid’ => ’65534’,
’x’ => ’x’,
’user’ => ’nfsnobody’,
’pass’ => ’!!’,
’disabled’ => true,
’history’ =>
array (
’history’ => false,
’user’ => ’nfsnobody’,
),
),
2 =>
array (
’shell’ => ’/bin/bash’,
’home’ => ’/home/axfrdns’,
’info’ => ’’,
’gid’ => ’500’,
’uid’ => ’500’,
’x’ => ’x’,
’user’ => ’axfrdns’,
’pass’ => ’!!’,
’disabled’ => true,
’history’ =>
array (
’history’ => false,
’user’ => ’axfrdns’,
),
),
),
)
Action: password
Added in version 4.7.0-339
Description Change a shell user password.
Input Parameters
Name Type Notes Required?
user string Example Values
root, nfsnobody, axfrdns, example
Yes
current_password string Help Entry
The current password, used to authenticate changes.
Yes
password string Yes
confirm_password string Help Entry
Confirm the password field by providing it again. Must match the password provided.
Yes
Action: queryChangeshell
Added in version 5.1.0-838
Description Displays the information available to the action "changeshell".
Input Parameters
Name Type Notes Required?
users struct (string) Example Values
example, nfsnobody, axfrdns
Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’shell’ => ’/sbin/nologin’,
’users’ =>
array (
0 => ’example’,
),
),
)
Action: queryShellOptions
Added in version 5.1.0-838
Description Displays the information available to the action "shellOptions".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’shell’ => ’/bin/bash’,
),
)
Action: shellOptions
Added in version 4.7.0-339
Description Change the default shell.
Input Parameters
Name Type Notes Required?
shell string Example Values
/bin/sh, /bin/bash, /sbin/nologin, /bin/dash, /usr/sbin/jk_chrootsh
Example Default Value
/bin/bash
No*
* indicates that it’s actually required, but probably already has a valid default value

52 Controller: /nodeworx/simplescripts

Action: editConfig
Added in version 4.7.0-339
Description Edit the simple scripts configuration.
Input Parameters
Name Type Notes Required?
selector integer Example Values
1, 0
Example Default Value
0
No*
host_key string No
host_api_key string No
reseller_config string Example Values
use_own, use_main
Example Default Value
use_own
No*
* indicates that it’s actually required, but probably already has a valid default value

53 Controller: /nodeworx/siteworx

Required Permissions "SWACCOUNTS"
Action: add
Added in version 4.7.0-339
Description Add a SiteWorx account.
Input Parameters
Name Type Notes Required?
master_domain string Help Entry
Enter the domain name you would like to setup a SiteWorx account for on this line. You should enter the domain name only, WITHOUT the ’www’ prefix (i.e. yourdomain.com and NOT www.yourdomain.com). If you would like to setup an account with a prefix, (i.e. games.yourdomain.com) you can do that here, and it will make a SiteWorx account for that domain. You can also setup yourdomain.com and then add a ’games’ subdomain from within SiteWorx if you prefer.
Yes
master_domain_ipv4 string Example Values
10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104
Yes
ipv6_pool string Example Values
0, dead::/24
Example Default Value
0
No*
master_domain_ipv6_from_pool string No
master_domain_ipv6 string Example Values
0, 2001:db8::d:1101
No
database_server string Help Entry
Select the database server from the list that you would like to use.
Example Values
localhost
Example Default Value
localhost
No*
uniqname string Yes
nickname string Help Entry
A ’nickname’ can be given to each SiteWorx account holder. This field is optional.
No
email string Help Entry
Enter the e-mail address of this SiteWorx account holder. This will serve as a contact address for the account and will be used by the account holder to log into SiteWorx.
Yes
encrypted string Description
"y" if the password is ALREADY encrypted, "n" if the password is not yet encrypted. Default: n
Example Values
y, n
Example Default Value
n
No*
password string Help Entry
Enter a password for the SiteWorx account holder and make it secure (i.e. long and random) ;).
Yes
confirm_password string Help Entry
Confirm the password field by providing it again. Must match the password provided.
Yes
language string Help Entry
Language used for user when logged in
Example Values
pl, de, ru, it, tr, en-us, hu, sv, sk, es, zh, da, nl, fr, cs, pt
Example Default Value
en-us
No*
theme string Example Values
blue_steel, calliope, coolfreshness, heliotrope, interstate, interworx, nexcess, vanillaice
Example Default Value
calliope
No*
menu_style string Example Values
big, small
Example Default Value
big
No*
billing_day integer Help Entry
The billing day is the day of the month (1-31) that this reseller’s monthly bandwidth calculation will start back at 0.
Example Values
1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31
Example Default Value
1
No*
php_version string Help Entry
Used for the master domain of the SiteWorx account, this also serves as the "default" version when adding new secondary domains.
Example Values
system-php, /opt/remi/php70, /opt/remi/php71
Example Default Value
/opt/remi/php71
No*
php_available struct (string) Help Entry
Versions of PHP to be available for the SiteWorx account to assign to domains.
Example Values
system-php, /opt/remi/php70, /opt/remi/php71
Example Default Value
["\/opt\/remi\/php71"]
No*
additional_ipv4 struct (string) Example Values
10.1.15.100, 10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104
Example Default Value
["10.1.15.100"]
No
additional_ipv6 struct (string) Example Values
2001:db8::d:1101
No
packagetemplate string Help Entry
A package template is a blueprint for the package to setup. You do not have to use a package template, but it is often easier to use one so you do not have to specify all options every time you setup a SiteWorx account.
Example Values
, unlimited, fifteens
No
create_package integer Example Values
1
No
new_package_name string No
OPT_STORAGE double Description
Megabytes
Help Entry
The amount of storage space allowed in megabytes
Yes
OPT_BANDWIDTH double Description
Gigabytes / Month
Help Entry
The amount of bandwidth allowed per month in gigabytes
Yes
OPT_EMAIL_ALIASES integer Help Entry
The number of e-mail aliases (often called e-mail forwards) allowed
Yes
OPT_EMAIL_AUTORESPONDERS integer Help Entry
The number of e-mail autoresponders, also called robots, allowed
Yes
OPT_EMAIL_BOXES integer Help Entry
The number of POP3/IMAP e-mail boxes allowed
Yes
OPT_EMAIL_GROUPS integer Help Entry
The number of group e-mail (aliases that send to multiple recipients) accounts allowed
Yes
OPT_FTP_ACCOUNTS integer Help Entry
The number of FTP accounts allowed
Yes
OPT_MYSQL_DBS integer Help Entry
The number of MySQL databases allowed
Yes
OPT_MYSQL_DB_USERS integer Help Entry
The number of MySQL users allowed
Yes
OPT_POINTER_DOMAINS integer Help Entry
The number of domains that can be pointed to this domain. Sometimes called "parked" domains.
Yes
OPT_SLAVE_DOMAINS integer Help Entry
The number of secondary domains allowed. Sometimes called "add-on" domains.
Yes
OPT_SUBDOMAINS integer Help Entry
The number of subdomains allowed
Yes
OPT_BACKUP integer Help Entry
Enables the ability to backup the account
Example Values
1, 0
Example Default Value
0
No*
OPT_CGI_ACCESS integer Help Entry
Indicator of whether or not CGI script access is enabled
Example Values
1, 0
Example Default Value
0
No*
OPT_CRONTAB integer Help Entry
Access to Crontab
Example Values
1, 0
Example Default Value
0
No*
OPT_DNS_RECORDS integer Help Entry
If yes, the SiteWorx account will be able to edit its own DNS records. (MX, SPF, and Domainkeys records are not effected by this setting)
Example Values
1, 0
Example Default Value
0
No*
OPT_SSL integer Help Entry
Enable SSL Certificates
Example Values
1, 0
Example Default Value
0
No*
OPT_BURSTABLE integer Help Entry
If you choose to be "burstable" your site will be able to go over its bandwidth allotment, perhaps at an extra cost (depending on the agreement). If you choose no, your bandwidth will be capped at a predefined limit and you will not be able to transfer any more data once the transfer limit is reached.
Example Values
1, 0
Example Default Value
0
No*
OPT_SAVE_XFER_LOGS integer Help Entry
If you answer yes to saving the transfer logs, the transfer logs will be saved in a format that can be downloaded. If you answer no, your logs are not saved and can not be downloaded and analyzed offline.
Example Values
1, 0
Example Default Value
0
No*
restart_httpd integer Example Values
1, 0
Example Default Value
1
No*
simplescripts 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: addIp
Added in version 5.0.14-579
Description Adds an IP to the list of available IPs for a SiteWorx account.
Input Parameters
Name Type Notes Required?
domain string Example Values
example.com
Yes
ipv4 struct (string) Example Values
10.1.15.102, 10.1.15.103, 10.1.15.104
No
ipv6 struct (string) Example Values
2001:db8::d:1101
No
Action: bulkactivate
Added in version 4.7.0-339
Description Bulk activate SiteWorx Accounts.
Warning This action has been deprecated as of version 4.8.0-393. 2011-01-20 Use unsuspend instead.
Input Parameters
Name Type Notes Required?
domains struct (string) Example Values
example.com
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: bulkdeactivate
Added in version 4.7.0-339
Description Bulk deactivate SiteWorx accounts.
Warning This action has been deprecated as of version 4.8.0-393. 2011-01-20 Use suspend instead.
Input Parameters
Name Type Notes Required?
domains struct (string) Example Values
example.com
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: bulkdelete
Added in version 4.7.0-339
Description Bulk delete SiteWorx accounts.
Warning This action has been deprecated as of version 4.8.0-393. 2011-01-20 Use delete instead.
Input Parameters
Name Type Notes Required?
domains struct (string) Example Values
example.com
Yes
confirm_action struct (integer) Example Values
1
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: delete
Added in version 4.7.0-339
Description Delete a SiteWorx Account.
Input Parameters
Name Type Notes Required?
domain struct (string) Example Values
example.com
Yes
purge_pool_ipv6 integer Help Entry
Selecting this option will cause any IPv6 addresses for this SiteWorx account to be deactivated and released back to the Pool if not in use elsewhere.
Example Values
1
Example Default Value
1
No
confirm_action struct (integer) Example Values
1
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: deleteConfig
Added in version 6.0.10-1379
Description Delete SiteWorx Level Config Data.
Input Parameters
Name Type Notes Required?
master_domain string Example Values
example.com
Yes
config_name string Yes
Action: edit
Added in version 4.7.0-339
Description Edit a SiteWorx account.
Input Parameters
Name Type Notes Required?
domain string Example Values
example.com
Yes
reseller integer Example Values
1, 16
Example Default Value
1
No*
status integer Example Values
1, 0
Example Default Value
1
No*
nickname string Help Entry
A ’nickname’ can be given to each SiteWorx account holder. This field is optional.
Example Default Value
Example User
No
email string Help Entry
Enter the e-mail address of this SiteWorx account holder. This will serve as a contact address for the account and will be used by the account holder to log into SiteWorx.
Example Default Value
user@example.com
No*
encrypted string Description
"y" if the password is ALREADY encrypted, "n" if the password is not yet encrypted. Default: n
Example Values
y, n
Example Default Value
n
No*
password string Help Entry
Enter a password for the SiteWorx account holder and make it secure (i.e. long and random) ;).
No
confirm_password string Help Entry
Confirm the password field by providing it again. Must match the password provided.
No
language string Help Entry
Language used for user when logged in
Example Values
pl, de, ru, it, tr, en-us, hu, sv, sk, es, zh, da, nl, fr, cs, pt
Example Default Value
en-us
No*
theme string Example Values
blue_steel, calliope, coolfreshness, heliotrope, interstate, interworx, nexcess, vanillaice
Example Default Value
calliope
No*
menu_style string Example Values
big, small
Example Default Value
big
No*
billing_day integer Help Entry
The billing day is the day of the month (1-31) that this reseller’s monthly bandwidth calculation will start back at 0.
Example Values
1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31
Example Default Value
1
No*
php_version string Help Entry
This controls the default version pre-selected when adding new secondary domains.
Example Values
system-php, /opt/remi/php70, /opt/remi/php71
Example Default Value
/opt/remi/php71
No*
php_available struct (string) Help Entry
Versions of PHP to be available for the SiteWorx account to assign to domains.
Example Values
system-php, /opt/remi/php70, /opt/remi/php71
Example Default Value
["\/opt\/remi\/php71"]
No*
ipv6_pool string Help Entry
Changing the IPv6 Pool will affect future IP assignments only. Current IPv6 assignments will not be changed.
Example Values
0, dead::/24
Example Default Value
0
No*
packagetemplate string Help Entry
A package template is a blueprint for the package to setup. You do not have to use a package template, but it is often easier to use one so you do not have to specify all options every time you setup a SiteWorx account.
Example Values
__example.com, unlimited, fifteens
Example Default Value
__example.com
No
OPT_STORAGE double Description
Megabytes
Help Entry
The amount of storage space allowed in megabytes
Example Default Value
999999999
No*
OPT_BANDWIDTH double Description
Gigabytes / Month
Help Entry
The amount of bandwidth allowed per month in gigabytes
Example Default Value
999999999
No*
OPT_EMAIL_ALIASES integer Help Entry
The number of e-mail aliases (often called e-mail forwards) allowed
Example Default Value
999999999
No*
OPT_EMAIL_AUTORESPONDERS integer Help Entry
The number of e-mail autoresponders, also called robots, allowed
Example Default Value
999999999
No*
OPT_EMAIL_BOXES integer Help Entry
The number of POP3/IMAP e-mail boxes allowed
Example Default Value
999999999
No*
OPT_EMAIL_GROUPS integer Help Entry
The number of group e-mail (aliases that send to multiple recipients) accounts allowed
Example Default Value
999999999
No*
OPT_FTP_ACCOUNTS integer Help Entry
The number of FTP accounts allowed
Example Default Value
999999999
No*
OPT_MYSQL_DBS integer Help Entry
The number of MySQL databases allowed
Example Default Value
999999999
No*
OPT_MYSQL_DB_USERS integer Help Entry
The number of MySQL users allowed
Example Default Value
999999999
No*
OPT_POINTER_DOMAINS integer Help Entry
The number of domains that can be pointed to this domain. Sometimes called "parked" domains.
Example Default Value
999999999
No*
OPT_SLAVE_DOMAINS integer Help Entry
The number of secondary domains allowed. Sometimes called "add-on" domains.
Example Default Value
999999999
No*
OPT_SUBDOMAINS integer Help Entry
The number of subdomains allowed
Example Default Value
999999999
No*
OPT_BACKUP integer Help Entry
Enables the ability to backup the account
Example Values
1, 0
Example Default Value
1
No*
OPT_CGI_ACCESS integer Help Entry
Indicator of whether or not CGI script access is enabled
Example Values
1, 0
Example Default Value
1
No*
OPT_CRONTAB integer Help Entry
Access to Crontab
Example Values
1, 0
Example Default Value
1
No*
OPT_DNS_RECORDS integer Help Entry
If yes, the SiteWorx account will be able to edit its own DNS records. (MX, SPF, and Domainkeys records are not effected by this setting)
Example Values
1, 0
Example Default Value
1
No*
OPT_SSL integer Help Entry
Enable SSL Certificates
Example Values
1, 0
Example Default Value
1
No*
OPT_BURSTABLE integer Help Entry
If you choose to be "burstable" your site will be able to go over its bandwidth allotment, perhaps at an extra cost (depending on the agreement). If you choose no, your bandwidth will be capped at a predefined limit and you will not be able to transfer any more data once the transfer limit is reached.
Example Values
1, 0
Example Default Value
1
No*
OPT_SAVE_XFER_LOGS integer Help Entry
If you answer yes to saving the transfer logs, the transfer logs will be saved in a format that can be downloaded. If you answer no, your logs are not saved and can not be downloaded and analyzed offline.
Example Values
1, 0
Example Default Value
1
No*
simplescripts 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: listAccounts
Added in version 4.8.0-393
Description List Siteworx accounts summary.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’siteworx_id’ => ’272’,
’uniqname’ => ’example’,
’date_created’ => ’1507623879’,
’status’ => ’active’,
’nodeworx_id’ => ’1’,
’package_id’ => ’276’,
’nickname’ => ’Example User’,
’email’ => ’user@example.com’,
’user_type’ => ’master’,
’domain’ => ’example.com’,
’domain_type’ => ’master’,
’storage’ => ’0’,
’storage_pct’ => ’0’,
’bandwidth’ => ’0’,
’bandwidth_pct’ => ’0’,
’max_bandwidth’ => ’999999999’,
’max_storage’ => ’999999999’,
’is_favorite’ => ’0’,
),
),
)
Action: listBandwidthAndStorage
Added in version 4.7.0-339
Description Lists bandwidth and storage usage for the current billing period.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’id’ => ’272’,
’domain’ => ’example.com’,
’bandwidth_used’ => ’0.00’,
’bandwidth’ => ’999999999’,
’storage_used’ => ’0.00’,
’storage’ => ’999999999’,
),
),
)
Action: listBandwidthAndStorageInMB
Added in version 5.1.0-838
Description Lists bandwidth and storage usage for the current billing period in MB.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’id’ => ’272’,
’domain’ => ’example.com’,
’bandwidth_used’ => 0,
’bandwidth’ => ’999999999’,
’storage_used’ => 0,
’storage’ => ’999999999’,
),
),
)
Action: listCurrentDomainBandwidthData
Added in version 4.7.0-339
Description List bw data for all master and secondary domains for the active biling period.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’reseller_id’ => ’1’,
’email’ => ’nodeworx_user@example.com’,
’domain_name’ => ’example.com’,
’master_domain’ => ’example.com’,
’bw_type’ => ’http’,
’in_counter’ => ’0’,
’out_counter’ => ’0’,
’in_bytes’ => ’0’,
’out_bytes’ => ’0’,
),
),
)
Action: listDedicatedFreeIps
Added in version 4.7.0-339
Description List available dedicated ip addresses.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
0 => ’10.1.15.103’,
1 => ’10.1.15.103 (Dedicated)’,
),
1 =>
array (
0 => ’10.1.15.104’,
1 => ’10.1.15.104 (Dedicated)’,
),
),
)
Action: listFreeIps
Added in version 4.7.0-339
Description List available ip addresses.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
0 => ’10.1.15.100’,
1 => ’10.1.15.100 (Shared)’,
),
1 =>
array (
0 => ’10.1.15.101’,
1 => ’10.1.15.101 (Shared)’,
),
2 =>
array (
0 => ’10.1.15.102’,
1 => ’10.1.15.102 (Shared)’,
),
),
)
Action: listMasterDomains
Added in version 4.7.0-339
Description List master domains.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’example.com’,
),
)
Action: listSharedFreeIps
Added in version 4.7.0-339
Description List available shared ip addresses.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
0 => ’10.1.15.100’,
1 => ’10.1.15.100 (Shared)’,
),
1 =>
array (
0 => ’10.1.15.101’,
1 => ’10.1.15.101 (Shared)’,
),
2 =>
array (
0 => ’10.1.15.102’,
1 => ’10.1.15.102 (Shared)’,
),
),
)
Action: listSiteworxAccounts
Added in version 4.7.0-339
Description List SiteWorx accounts (id, status, domain).
Warning This action has been deprecated as of version 4.8.0-393. 2011-01-21 Use listAccounts.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’id’ => ’272’,
’domain’ => ’example.com’,
’status’ => ’active’,
),
),
)
Action: queryAccountBandwidth
Added in version 4.9.0-427
Description Query Siteworx Account bandwidth usage data for any billing period.
Input Parameters
Name Type Notes Required?
domains struct (string) Help Entry
Select accounts to view bandwidth data for. Selecting none is the same as selecting all.
Example Values
example.com
No
timestamp integer Help Entry
A Unix Timestamp to identify the billing period from which the bandwidth data will be shown. If blank, defaults to the current time.
No
Action: queryAvailableIps
Added in version 5.0.14-579
Description Displays Ips that are available to a master siteworx account.
Input Parameters
Name Type Notes Required?
domain string Example Values
example.com
Yes
Action: queryConfig
Added in version 6.0.10-1379
Description Query SiteWorx Level Config Data.
Input Parameters
Name Type Notes Required?
master_domain string Example Values
example.com
Yes
config_name string Yes
Action: queryDomainInfo
Added in version 4.9.0-427
Description Get info about a domain on the system. Can be used to see if a domain exists.
Input Parameters
Name Type Notes Required?
domain string Example Values
example.com, sub.example.com, pointer.com, secondary.com
Yes
Action: queryEdit
Added in version 5.1.0-838
Description Displays the information available to the action "edit".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’master_domain’ => ’example.com’,
’master_domain_ipv4’ => ’10.1.15.100’,
’database_server’ => ’localhost’,
’reseller’ => ’1’,
’uniqname’ => ’example’,
’status’ => ’active’,
’nickname’ => ’Example User’,
’email’ => ’user@example.com’,
’encrypted’ => ’n’,
’password’ => NULL,
’confirm_password’ => NULL,
’language’ => ’en-us’,
’theme’ => ’calliope’,
’menu_style’ => ’big’,
’billing_day’ => ’1’,
’php_version’ => ’/opt/remi/php71’,
’php_available’ =>
array (
0 => ’/opt/remi/php71’,
),
’additional_ipv4’ =>
array (
0 => ’10.1.15.100’,
1 => ’10.1.15.101’,
),
’ipv6_pool’ => ’0’,
’additional_ipv6’ =>
array (
),
’packagetemplate’ => ’__example.com’,
’OPT_STORAGE’ => ’999999999’,
’OPT_BANDWIDTH’ => ’999999999’,
’OPT_EMAIL_ALIASES’ => ’999999999’,
’OPT_EMAIL_AUTORESPONDERS’ => ’999999999’,
’OPT_EMAIL_BOXES’ => ’999999999’,
’OPT_EMAIL_GROUPS’ => ’999999999’,
’OPT_FTP_ACCOUNTS’ => ’999999999’,
’OPT_MYSQL_DBS’ => ’999999999’,
’OPT_MYSQL_DB_USERS’ => ’999999999’,
’OPT_POINTER_DOMAINS’ => ’999999999’,
’OPT_SLAVE_DOMAINS’ => ’999999999’,
’OPT_SUBDOMAINS’ => ’999999999’,
’OPT_BACKUP’ => ’true’,
’OPT_CGI_ACCESS’ => ’true’,
’OPT_CRONTAB’ => ’true’,
’OPT_DNS_RECORDS’ => ’true’,
’OPT_SSL’ => ’true’,
’OPT_BURSTABLE’ => ’true’,
’OPT_SAVE_XFER_LOGS’ => ’true’,
’simplescripts’ => ’1’,
’domain’ => ’example.com’,
’options’ =>
array (
’LG_OPT_STORAGE’ => ’999999999’,
’LG_OPT_BANDWIDTH’ => ’999999999’,
’LG_OPT_EMAIL_ALIASES’ => ’999999999’,
’LG_OPT_EMAIL_AUTORESPONDERS’ => ’999999999’,
’LG_OPT_EMAIL_BOXES’ => ’999999999’,
’LG_OPT_EMAIL_GROUPS’ => ’999999999’,
’LG_OPT_FTP_ACCOUNTS’ => ’999999999’,
’LG_OPT_MYSQL_DBS’ => ’999999999’,
’LG_OPT_MYSQL_DB_USERS’ => ’999999999’,
’LG_OPT_POINTER_DOMAINS’ => ’999999999’,
’LG_OPT_SLAVE_DOMAINS’ => ’999999999’,
’LG_OPT_SUBDOMAINS’ => ’999999999’,
’LG_OPT_BACKUP’ => ’true’,
’LG_OPT_CGI_ACCESS’ => ’true’,
’LG_OPT_CRONTAB’ => ’true’,
’LG_OPT_DNS_RECORDS’ => ’true’,
’LG_OPT_SSL’ => ’true’,
’LG_OPT_BURSTABLE’ => ’true’,
’LG_OPT_SAVE_XFER_LOGS’ => ’true’,
),
’ipaddr’ => ’10.1.15.100’,
’password1’ => NULL,
’password2’ => NULL,
’package_name’ => ’__example.com’,
),
)
Action: queryIps
Added in version 5.1.0-838
Description Displays the information available to the action "ips".
Input Parameters
Name Type Notes Required?
domain string Example Values
example.com
Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’domain_copy’ => ’example.com’,
’domain’ => ’example.com’,
),
)
Action: querySiteworxAccountDetails
Added in version 4.7.0-339
Description Get all SiteWorx account properties of a given domain.
Input Parameters
Name Type Notes Required?
domain string Example Values
example.com
Yes
Action: querySiteworxAccounts
Added in version 4.7.0-339
Description Query Siteworx accounts by specifying which properties you want returned.
Input Parameters
Name Type Notes Required?
domain struct (string) Example Values
example.com
Example Default Value
["example.com"]
No*
account_data struct (string) Example Values
id, status, billingday, external_id, unixuser, date_created, nickname, email, language, theme, domain, ip, package_name, storage_used, bandwidth_used, uid, gid, reseller_id, opt_storage, opt_bandwidth, opt_email_aliases, opt_email_autoresponders, opt_email_boxes, opt_email_groups, opt_ftp_accounts, opt_mysql_dbs, opt_mysql_db_users, opt_pointer_domains, opt_slave_domains, opt_subdomains, opt_backup, opt_cgi_access, opt_crontab, opt_dns_records, opt_ssl, opt_burstable, opt_save_xfer_logs, all_package_options
Example Default Value
["id","status","domain"]
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: removeIp
Added in version 5.0.14-579
Description Removes IPs from SiteWorx account.
Input Parameters
Name Type Notes Required?
domain string Example Values
example.com
Yes
ip struct (string) Example Values
10.1.15.101
Yes
Action: search
Added in version 4.8.0-393
Description Search siteworx accounts summary.
Input Parameters
Name Type Notes Required?
query string No
reseller string Example Values
all, 1, 16
Yes
Action: setConfig
Added in version 6.0.10-1379
Description Set SiteWorx Level Config Data.
Input Parameters
Name Type Notes Required?
master_domain string Example Values
example.com
Yes
config_name string Yes
config_value