Chapter 54: Controller: /nodeworx/simplescripts Up Part II: NodeWorx API Spec Chapter 56: Controller: /nodeworx/sshd 

55 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*
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
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*
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*
fpm_max_children integer Help Entry
Limits the number of simultaneous requests. Be careful with large numbers, as too many high-memory requests can cause the server to swap.
Example Default Value
4
No*
fpm_max_requests integer Help Entry
The number of requests each child process should execute before respawning. This can be useful to work around memory leaks in 3rd party libraries. For endless request processing specify ’0’
Example Default Value
8192
No*
fpm_process_management string Help Entry
Choose how the process manager will control the number of child processes. Possible values: static, ondemand, dynamic.
Example Values
dynamic, static, ondemand
Example Default Value
ondemand
No*
fpm_start_servers integer Help Entry
The number of child processes created on startup. Used only when pm is set to dynamic.
Example Default Value
2
No
fpm_min_spare_servers integer Help Entry
The desired minimum number of idle server processes. Used only when pm is set to dynamic.
Example Default Value
1
No
fpm_max_spare_servers integer Help Entry
The desired maximum number of idle server processes. Used only when pm is set to dynamic.
Example Default Value
4
No
fpm_process_idle_timeout string Help Entry
The number of seconds after which an idle process will be killed. Used only when pm is set to ondemand. Available units: s(econds)(default), m(inutes), h(ours), or d(ays).
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 struct (string) No*
* 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 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*
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*
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*
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*
fpm_max_children integer Help Entry
Limits the number of simultaneous requests. Be careful with large numbers, as too many high-memory requests can cause the server to swap.
Example Default Value
4
No*
fpm_max_requests integer Help Entry
The number of requests each child process should execute before respawning. This can be useful to work around memory leaks in 3rd party libraries. For endless request processing specify ’0’
Example Default Value
8192
No*
fpm_process_management string Help Entry
Choose how the process manager will control the number of child processes. Possible values: static, ondemand, dynamic.
Example Values
dynamic, static, ondemand
Example Default Value
ondemand
No*
fpm_start_servers integer Help Entry
The number of child processes created on startup. Used only when pm is set to dynamic.
Example Default Value
2
No
fpm_min_spare_servers integer Help Entry
The desired minimum number of idle server processes. Used only when pm is set to dynamic.
Example Default Value
1
No
fpm_max_spare_servers integer Help Entry
The desired maximum number of idle server processes. Used only when pm is set to dynamic.
Example Default Value
4
No
fpm_process_idle_timeout string Help Entry
The number of seconds after which an idle process will be killed. Used only when pm is set to ondemand. Available units: s(econds)(default), m(inutes), h(ours), or d(ays).
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: fail
Added in version n/a
Description Magic function - test for failure mechanism.
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’ => ’282’,
’uniqname’ => ’example’,
’date_created’ => ’1531337335’,
’status’ => ’active’,
’nodeworx_id’ => ’1’,
’package_id’ => ’286’,
’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’,
’php_version’ => ’/opt/remi/php71’,
’homedir’ => ’/chroot/home/example’,
’domainroot’ => ’/chroot/home/example/example.com’,
’docroot’ => ’/chroot/home/example/example.com/html’,
),
),
)
Action: listBandwidthAndStorage
Added in version 4.7.0-339
Description Lists bandwidth and storage usage for current billing period in megabytes.
Warning This action has been deprecated as of version 6.1.23-1488. 2017-10-12
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’id’ => ’282’,
’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 current billing period in megabytes.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’id’ => ’282’,
’domain’ => ’example.com’,
’bandwidth_used’ => ’0.00’,
’bandwidth’ => 1023999998976,
’storage_used’ => ’0.00’,
’storage’ => ’999999999’,
),
),
)
Action: listConfig
Added in version 6.1.22-1486
Description List all SiteWorx Level Config Data.
Input Parameters
Name Type Notes Required?
master_domain string Example Values
example.com
Yes
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: listDomainAccounts
Added in version 6.1.23-1488
Description List Siteworx accounts including master and secondary domain details.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’siteworx_id’ => ’282’,
’uniqname’ => ’example’,
’date_created’ => ’1531337335’,
’status’ => ’active’,
’nodeworx_id’ => ’1’,
’package_id’ => ’286’,
’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’,
’php_version’ => ’/opt/remi/php71’,
’homedir’ => ’/chroot/home/example’,
’domainroot’ => ’/chroot/home/example/example.com’,
’docroot’ => ’/chroot/home/example/example.com/html’,
),
1 =>
array (
’siteworx_id’ => ’282’,
’uniqname’ => ’example’,
’date_created’ => ’1531337335’,
’status’ => ’active’,
’nodeworx_id’ => ’1’,
’package_id’ => ’286’,
’nickname’ => ’Example User’,
’email’ => ’user@example.com’,
’user_type’ => ’master’,
’domain’ => ’secondary.com’,
’domain_type’ => ’slave’,
’storage’ => ’0’,
’storage_pct’ => ’0’,
’bandwidth’ => ’0’,
’bandwidth_pct’ => ’0’,
’max_bandwidth’ => ’999999999’,
’max_storage’ => ’999999999’,
’is_favorite’ => ’0’,
’php_version’ => ’/opt/remi/php71’,
’homedir’ => ’/chroot/home/example’,
’domainroot’ => ’/chroot/home/example/secondary.com’,
’docroot’ => ’/chroot/home/example/secondary.com/html’,
’master_domain’ => ’example.com’,
),
),
)
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’ => ’282’,
’domain’ => ’example.com’,
’status’ => ’active’,
),
),
)
Action: matchPackagesWithTemplates
Added in version 6.1.1-1445
Description Find existing package template names and match account packages to them.
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: queryDomain
Added in version 4.9.0-427
Description Query the system for a domain information.
Input Parameters
Name Type Notes Required?
domain 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
secondary.com, pointer.com, example.com, sub.example.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’,
’additional_ipv4’ =>
array (
0 => ’10.1.15.100’,
1 => ’10.1.15.101’,
),
’ipv6_pool’ => ’0’,
’additional_ipv6’ =>
array (
),
’php_version’ => ’/opt/remi/php71’,
’php_available’ =>
array (
0 => ’/opt/remi/php71’,
),
’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’,
’fpm_max_children’ => ’4’,
’fpm_max_requests’ => ’8192’,
’fpm_process_management’ => ’ondemand’,
’fpm_start_servers’ => ’2’,
’fpm_min_spare_servers’ => ’1’,
’fpm_max_spare_servers’ => ’4’,
’fpm_process_idle_timeout’ => ’120s’,
’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, date_inactive, inactive_msg, 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: reroute
Added in version n/a
Description Action to re-route from the current controller to a different one.
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 struct (string) No*
config_value struct (string) No
* indicates that it’s actually required, but probably already has a valid default value
Action: siteworxLogin
Added in version 4.7.0-339
Description Login to a given SiteWorx account.
Input Parameters
Name Type Notes Required?
login_domain string Example Values
secondary.com, pointer.com, example.com, sub.example.com
Yes
account_action string Example Values
siteworxLogin, edit
Example Default Value
siteworxLogin
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: suspend
Added in version 4.7.0-339
Description Suspend a SiteWorx account.
Input Parameters
Name Type Notes Required?
domain struct (string) Example Values
example.com
Yes
message string Help Entry
This optional message will be displayed to users when they attempt to login to SiteWorx. It will also be visible in NodeWorx.
No
Action: suspendByUser
Added in version 4.8.0-393
Description Suspend a SiteWorx account by unix user name.
Input Parameters
Name Type Notes Required?
user struct (string) Example Values
example
Yes
Action: syncServerAlias
Added in version 4.7.0-339
Description Synchronize server aliases with InterWorx database.
Input Parameters
Name Type Notes Required?
domain string Example Values
example.com, secondary.com
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: syncVirtualHosts
Added in version 4.7.0-339
Description Synchronize InterWorx and Apache vitrual host blocks.
Input Parameters
Name Type Notes Required?
domain string Example Values
example.com
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: toggleFavorite
Added in version 4.7.0-339
Description Toggle a "favorite" SiteWorx account.
Input Parameters
Name Type Notes Required?
domain string Example Values
example.com
Yes
Action: unsuspend
Added in version 4.7.0-339
Description Unsuspend a SiteWorx account.
Input Parameters
Name Type Notes Required?
domain struct (string) Example Values
example.com
Yes
Action: unsuspendByUser
Added in version 4.8.0-393
Description Unsuspend a SiteWorx account by unix user name.
Input Parameters
Name Type Notes Required?
user struct (string) Example Values
example
Yes
Action: win
Added in version n/a
Description Magic function - test for testing success mechanism.
 Chapter 54: Controller: /nodeworx/simplescripts Up Part II: NodeWorx API Spec Chapter 56: Controller: /nodeworx/sshd 

(C) 2018 by InterWorx LLC