Controller: /nodeworx/siteworx ============================== :Required Permissions: SWACCOUNTS Action: ``add`` --------------- :Added in Version: 4.7.0-339 :Description: Add a SiteWorx account. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``master_domain`` - string - Yes - - - 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. * - ``master_domain_ipv4`` - string - Yes - 192.168.0.3, 192.168.0.4, 192.168.0.5 - - * - ``ipv6_pool`` - string - No* - 0, 2001::/24 - 0 - * - ``master_domain_ipv6_from_pool`` - string - No - - - * - ``master_domain_ipv6`` - integer - No - 0 - - * - ``database_server`` - string - No* - localhost, remote_db - localhost - Select the database server from the list that you would like to use. * - ``uniqname`` - string - Yes - - - * - ``nickname`` - string - No - - - A 'nickname' can be given to each SiteWorx account holder. This field is optional. * - ``email`` - string - Yes - - - Enter the email 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. * - ``encrypted`` - string - No* - y, n - n - "y" if the password is ALREADY encrypted, "n" if the password is not yet encrypted. Default: n * - ``password`` - string - Yes - - - Enter a password for the SiteWorx account holder and make it secure (i.e. long and random) ;). * - ``confirm_password`` - string - Yes - - - Confirm the password field by providing it again. Must match the password provided. * - ``requires_password_change`` - integer - No - 1 - - If selected, the next time this user logs in via the web, they will be forced to change their password before doing anything else. * - ``language`` - string - No* - cs, da, de, en-us, es, fr, hu, it, nl, pl, pt, ru, sk, sv, tr, zh - en-us - Language used for user when logged in * - ``theme`` - string - No - - - * - ``menu_style`` - string - No - - - * - ``billing_day`` - integer - No* - 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 - 1 - The billing day is the day of the month (1-31) that this reseller's monthly bandwidth calculation will start back at 0. * - ``additional_ipv4`` - struct (string) - No - 192.168.0.3, 192.168.0.4, 192.168.0.5 - ["192.168.0.3"] - * - ``php_version`` - string - No* - system-php, /opt/remi/php72, /opt/remi/php74, /opt/remi/php80 - system-php - Used for the master domain of the SiteWorx account, this also serves as the "default" version when adding new secondary domains. * - ``php_available`` - struct (string) - No* - system-php, /opt/remi/php72, /opt/remi/php74, /opt/remi/php80 - ["system-php"] - Versions of PHP to be available for the SiteWorx account to assign to domains. * - ``packagetemplate`` - string - No - Unlimited, Fifteens - - 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. * - ``create_package`` - integer - No - 1 - - * - ``new_package_name`` - string - No - - - * - ``OPT_STORAGE`` - double - Yes - - - The amount of storage space allowed in megabytes - *Megabytes* * - ``OPT_BANDWIDTH`` - double - Yes - - - The amount of bandwidth allowed per month in gigabytes - *Gigabytes / Month* * - ``OPT_EMAIL_ALIASES`` - integer - Yes - - - The number of email aliases (often called email forwards) allowed * - ``OPT_EMAIL_AUTORESPONDERS`` - integer - Yes - - - The number of email autoresponders, also called robots, allowed * - ``OPT_EMAIL_BOXES`` - integer - Yes - - - The number of POP3/IMAP email boxes allowed * - ``OPT_EMAIL_GROUPS`` - integer - Yes - - - The number of group email (aliases that send to multiple recipients) accounts allowed * - ``OPT_FTP_ACCOUNTS`` - integer - Yes - - - The number of FTP accounts allowed * - ``OPT_MYSQL_DBS`` - integer - Yes - - - The number of MySQL databases allowed * - ``OPT_MYSQL_DB_USERS`` - integer - Yes - - - The number of MySQL users allowed * - ``OPT_POINTER_DOMAINS`` - integer - Yes - - - The number of domains that can be pointed to this domain. Sometimes called "parked" domains. * - ``OPT_SLAVE_DOMAINS`` - integer - Yes - - - The number of secondary domains allowed. Sometimes called "add-on" domains. * - ``OPT_SUBDOMAINS`` - integer - Yes - - - The number of subdomains allowed * - ``OPT_BACKUP`` - integer - No* - 1, 0 - 0 - Enables the ability to backup the account * - ``OPT_CGI_ACCESS`` - integer - No* - 1, 0 - 0 - Indicator of whether or not CGI script access is enabled * - ``OPT_CRONTAB`` - integer - No* - 1, 0 - 0 - Access to Crontab * - ``OPT_DNS_RECORDS`` - integer - No* - 1, 0 - 0 - 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) * - ``OPT_MAILMAN`` - integer - No* - 1, 0 - 0 - Enable Mailman access * - ``OPT_SSL`` - integer - No* - 1, 0 - 0 - Enable SSL Certificates * - ``OPT_BURSTABLE`` - integer - No* - 1, 0 - 0 - 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. * - ``OPT_SAVE_XFER_LOGS`` - integer - No* - 1, 0 - 0 - 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. * - ``fpm_max_children`` - integer - No* - - 4 - Limits the number of simultaneous requests. Be careful with large numbers, as too many high-memory requests can cause the server to swap. * - ``fpm_max_requests`` - integer - No* - - 8192 - 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' * - ``fpm_process_management`` - string - No* - dynamic, static, ondemand - ondemand - Choose how the process manager will control the number of child processes. Possible values: static, ondemand, dynamic. * - ``fpm_start_servers`` - integer - No - - 2 - The number of child processes created on startup. Used only when pm is set to dynamic. * - ``fpm_min_spare_servers`` - integer - No - - 1 - The desired minimum number of idle server processes. Used only when pm is set to dynamic. * - ``fpm_max_spare_servers`` - integer - No - - 4 - The desired maximum number of idle server processes. Used only when pm is set to dynamic. * - ``fpm_process_idle_timeout`` - string - No - - - 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). * - ``restart_httpd`` - integer - No* - 1, 0 - 1 - * - ``softaculous`` - integer - No* - 1, 0 - 1 - \* 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 ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - example.com - - * - ``ipv4`` - struct (string) - No - 192.168.0.4, 192.168.0.5 - - * - ``ipv6`` - struct (integer) - 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 ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domains`` - struct (string) - No* - example.com - - \* 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 ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domains`` - struct (string) - No* - example.com - - \* indicates that it's actually required, but probably already has a valid default value. Action: ``changePhpVersion`` ---------------------------- :Added in Version: 6.3.3-1639 :Description: Change the PHP version for the entire SiteWorx account, including all domains. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``master_domain`` - string - Yes - example.com - - * - ``php_version`` - string - No* - system-php, /opt/remi/php72, /opt/remi/php74, /opt/remi/php80 - system-php - Used for the master domain of the SiteWorx account, this also serves as the "default" version when adding new secondary domains. \* 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 ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - struct (string) - Yes - example.com - - * - ``purge_pool_ipv6`` - integer - No - 1 - 1 - 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. * - ``confirm_action`` - struct (integer) - No* - 1 - - \* 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 ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``master_domain`` - string - Yes - example.com - - * - ``config_name`` - struct (string) - No* - - - \* indicates that it's actually required, but probably already has a valid default value. Action: ``deleteDomainConfig`` ------------------------------ :Added in Version: 6.4.1-1707 :Description: Delete Domain Level Config Data. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - example.com, secondary.com - - * - ``config_name`` - string - Yes - - - Action: ``edit`` ---------------- :Added in Version: 4.7.0-339 :Description: Edit a SiteWorx account. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - example.com - - * - ``reseller`` - integer - No* - 1, 2 - 1 - * - ``status`` - integer - No* - 1, 0 - 1 - * - ``nickname`` - string - No - - Example User - A 'nickname' can be given to each SiteWorx account holder. This field is optional. * - ``email`` - string - No* - - user@example.com - Enter the email 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. * - ``encrypted`` - string - No* - y, n - n - "y" if the password is ALREADY encrypted, "n" if the password is not yet encrypted. Default: n * - ``password`` - string - No - - - Enter a password for the SiteWorx account holder and make it secure (i.e. long and random) ;). * - ``confirm_password`` - string - No - - - Confirm the password field by providing it again. Must match the password provided. * - ``reset_passwords`` - struct (string) - No - EMAIL, FTP - - Sync updated password with default ftp account, postmaster, and/or default shell user. * - ``requires_password_change`` - integer - No - 1 - - If selected, the next time this user logs in via the web, they will be forced to change their password before doing anything else. * - ``language`` - string - No* - cs, da, de, en-us, es, fr, hu, it, nl, pl, pt, ru, sk, sv, tr, zh - en-us - Language used for user when logged in * - ``theme`` - string - No - - - * - ``menu_style`` - string - No - - - * - ``billing_day`` - integer - No* - 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 - 1 - The billing day is the day of the month (1-31) that this reseller's monthly bandwidth calculation will start back at 0. * - ``ipv6_pool`` - string - No* - 0, 2001::/24 - 0 - Changing the IPv6 Pool will affect future IP assignments only. Current IPv6 assignments will not be changed. * - ``php_version`` - string - No* - system-php, /opt/remi/php72, /opt/remi/php74, /opt/remi/php80 - system-php - This controls the default version pre-selected when adding new secondary domains. * - ``php_available`` - struct (string) - No* - system-php, /opt/remi/php72, /opt/remi/php74, /opt/remi/php80 - ["\/opt\/remi\/php74","\/opt\/remi\/php80","system-php"] - Versions of PHP to be available for the SiteWorx account to assign to domains. * - ``packagetemplate`` - string - No - __example.com, Unlimited, Fifteens - __example.com - 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. * - ``OPT_STORAGE`` - double - No* - - 999999999 - The amount of storage space allowed in megabytes - *Megabytes* * - ``OPT_BANDWIDTH`` - double - No* - - 999999999 - The amount of bandwidth allowed per month in gigabytes - *Gigabytes / Month* * - ``OPT_EMAIL_ALIASES`` - integer - No* - - 999999999 - The number of email aliases (often called email forwards) allowed * - ``OPT_EMAIL_AUTORESPONDERS`` - integer - No* - - 999999999 - The number of email autoresponders, also called robots, allowed * - ``OPT_EMAIL_BOXES`` - integer - No* - - 999999999 - The number of POP3/IMAP email boxes allowed * - ``OPT_EMAIL_GROUPS`` - integer - No* - - 999999999 - The number of group email (aliases that send to multiple recipients) accounts allowed * - ``OPT_FTP_ACCOUNTS`` - integer - No* - - 999999999 - The number of FTP accounts allowed * - ``OPT_MYSQL_DBS`` - integer - No* - - 999999999 - The number of MySQL databases allowed * - ``OPT_MYSQL_DB_USERS`` - integer - No* - - 999999999 - The number of MySQL users allowed * - ``OPT_POINTER_DOMAINS`` - integer - No* - - 999999999 - The number of domains that can be pointed to this domain. Sometimes called "parked" domains. * - ``OPT_SLAVE_DOMAINS`` - integer - No* - - 999999999 - The number of secondary domains allowed. Sometimes called "add-on" domains. * - ``OPT_SUBDOMAINS`` - integer - No* - - 999999999 - The number of subdomains allowed * - ``OPT_BACKUP`` - integer - No* - 1, 0 - 1 - Enables the ability to backup the account * - ``OPT_CGI_ACCESS`` - integer - No* - 1, 0 - 1 - Indicator of whether or not CGI script access is enabled * - ``OPT_CRONTAB`` - integer - No* - 1, 0 - 1 - Access to Crontab * - ``OPT_DNS_RECORDS`` - integer - No* - 1, 0 - 1 - 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) * - ``OPT_MAILMAN`` - integer - No* - 1, 0 - 1 - Enable Mailman access * - ``OPT_SSL`` - integer - No* - 1, 0 - 1 - Enable SSL Certificates * - ``OPT_BURSTABLE`` - integer - No* - 1, 0 - 1 - 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. * - ``OPT_SAVE_XFER_LOGS`` - integer - No* - 1, 0 - 1 - 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. * - ``fpm_max_children`` - integer - No* - - 4 - Limits the number of simultaneous requests. Be careful with large numbers, as too many high-memory requests can cause the server to swap. * - ``fpm_max_requests`` - integer - No* - - 8192 - 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' * - ``fpm_process_management`` - string - No* - dynamic, static, ondemand - ondemand - Choose how the process manager will control the number of child processes. Possible values: static, ondemand, dynamic. * - ``fpm_start_servers`` - integer - No - - 2 - The number of child processes created on startup. Used only when pm is set to dynamic. * - ``fpm_min_spare_servers`` - integer - No - - 1 - The desired minimum number of idle server processes. Used only when pm is set to dynamic. * - ``fpm_max_spare_servers`` - integer - No - - 4 - The desired maximum number of idle server processes. Used only when pm is set to dynamic. * - ``fpm_process_idle_timeout`` - string - No - - - 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). * - ``softaculous`` - integer - No* - 1, 0 - 1 - \* indicates that it's actually required, but probably already has a valid default value. Action: ``editDomainIp`` ------------------------ :Added in Version: 6.3.17-1685 :Description: Edit the ip for a single domain. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - example.com - - * - ``ipv4`` - string - No* - - 192.168.0.3 - \* 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 ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 'siteworx_id' => '1', 'uniqname' => 'example', 'date_created' => '1578808273', 'status' => 'active', 'nodeworx_id' => '1', 'package_id' => '3', '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' => 'system-php', 'homedir' => '/home/example', 'domainroot' => '/home/example/example.com', 'docroot' => '/home/example/example.com/html', 'unixuser' => 'example', ), ), 'reply_code' => 205, ) Action: ``listAllDomains`` -------------------------- :Added in Version: 7.13.1-2389 :Description: List all sw domains Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 'domain' => 'example.com', 'domain_type' => 'master', 'domain_status' => 'active', 'domain_root' => '/home/example/example.com', 'domain_docroot' => '/home/example/example.com/html', 'domain_ipv4' => '192.168.0.3', 'domain_ipv6' => '', 'master_domain' => 'example.com', 'unix_user' => 'example', 'pointer_type' => '', 'points_to' => '', 'php_version' => 'system-php', ), 1 => array ( 'domain' => 'secondary.com', 'domain_type' => 'slave', 'domain_status' => 'active', 'domain_root' => '/home/example/secondary.com', 'domain_docroot' => '/home/example/secondary.com/html', 'domain_ipv4' => '192.168.0.3', 'domain_ipv6' => '', 'master_domain' => 'example.com', 'unix_user' => 'example', 'pointer_type' => '', 'points_to' => '', 'php_version' => 'system-php', ), 2 => array ( 'domain' => 'sub.example.com', 'domain_type' => 'subdomain', 'domain_status' => 'active', 'domain_root' => '/home/example/example.com', 'domain_docroot' => '/home/example/example.com/html/sub', 'domain_ipv4' => '192.168.0.3', 'domain_ipv6' => '', 'master_domain' => 'example.com', 'unix_user' => 'example', 'pointer_type' => '', 'points_to' => '', 'php_version' => 'system-php', ), ), 'reply_code' => 205, ) 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 ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 'id' => '1', 'domain' => 'example.com', 'bandwidth_used' => '0.00', 'bandwidth' => '999999999', 'storage_used' => '0.00', 'storage' => '999999999', ), ), 'reply_code' => 205, ) Action: ``listBandwidthAndStorageInMB`` --------------------------------------- :Added in Version: 5.1.0-838 :Description: Lists bandwidth and storage usage for current billing period in megabytes. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 'id' => '1', 'domain' => 'example.com', 'bandwidth_used' => '0.00', 'bandwidth' => 1023999998976, 'storage_used' => '0.00', 'storage' => '999999999', ), ), 'reply_code' => 205, ) Action: ``listConfig`` ---------------------- :Added in Version: 6.1.22-1486 :Description: List all SiteWorx Level Config Data. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``master_domain`` - string - Yes - example.com - - 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 ^^^^^^^^^^^^^ .. code-block:: 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', ), ), 'reply_code' => 205, ) Action: ``listDedicatedFreeIps`` -------------------------------- :Added in Version: 4.7.0-339 :Description: List available dedicated ip addresses. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 0 => '', 1 => 'No Free IP Addresses', ), ), 'reply_code' => 205, ) Action: ``listDomainAccounts`` ------------------------------ :Added in Version: 6.1.23-1488 :Description: List Siteworx accounts including master and secondary domain details. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 'siteworx_id' => '1', 'uniqname' => 'example', 'date_created' => '1578808273', 'status' => 'active', 'nodeworx_id' => '1', 'package_id' => '3', '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' => 'system-php', 'homedir' => '/home/example', 'domainroot' => '/home/example/example.com', 'docroot' => '/home/example/example.com/html', ), 1 => array ( 'siteworx_id' => '1', 'uniqname' => 'example', 'date_created' => '1578808273', 'status' => 'active', 'nodeworx_id' => '1', 'package_id' => '3', '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' => 'system-php', 'homedir' => '/home/example', 'domainroot' => '/home/example/secondary.com', 'docroot' => '/home/example/secondary.com/html', 'master_domain' => 'example.com', ), ), 'reply_code' => 205, ) Action: ``listDomainConfig`` ---------------------------- :Added in Version: 6.4.1-1707 :Description: List all Domain Level Config Data. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - example.com, secondary.com - - Action: ``listFreeIps`` ----------------------- :Added in Version: 4.7.0-339 :Description: List available ip addresses. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 0 => '192.168.0.3', 1 => '192.168.0.3 (Shared)', ), 1 => array ( 0 => '192.168.0.4', 1 => '192.168.0.4 (Shared)', ), 2 => array ( 0 => '192.168.0.5', 1 => '192.168.0.5 (Shared)', ), ), 'reply_code' => 205, ) Action: ``listMasterDomains`` ----------------------------- :Added in Version: 4.7.0-339 :Description: List master domains. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => 'example.com', ), 'reply_code' => 205, ) Action: ``listSharedFreeIps`` ----------------------------- :Added in Version: 4.7.0-339 :Description: List available shared ip addresses. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 0 => '192.168.0.3', 1 => '192.168.0.3 (Shared)', ), 1 => array ( 0 => '192.168.0.4', 1 => '192.168.0.4 (Shared)', ), 2 => array ( 0 => '192.168.0.5', 1 => '192.168.0.5 (Shared)', ), ), 'reply_code' => 205, ) 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 ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 'id' => '1', 'domain' => 'example.com', 'status' => 'active', ), ), 'reply_code' => 205, ) 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 ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domains`` - struct (string) - No - example.com - - Select accounts to view bandwidth data for. Selecting none is the same as selecting all. * - ``timestamp`` - integer - No - - - A Unix Timestamp to identify the billing period from which the bandwidth data will be shown. If blank, defaults to the current time. Action: ``queryAvailableIps`` ----------------------------- :Added in Version: 5.0.14-579 :Description: Displays Ips that are available to a master siteworx account. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - example.com - - Action: ``queryConfig`` ----------------------- :Added in Version: 6.0.10-1379 :Description: Query SiteWorx Level Config Data. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``master_domain`` - string - Yes - example.com - - * - ``config_name`` - string - Yes - - - Action: ``queryDomain`` ----------------------- :Added in Version: 4.9.0-427 :Description: Query the system for a domain information. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - - - Action: ``queryDomainAccountDetails`` ------------------------------------- :Added in Version: 6.3.10-1665 :Description: Query domain account details. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - - - Action: ``queryDomainConfig`` ----------------------------- :Added in Version: 6.4.1-1707 :Description: Query Domain Level Config Data. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - example.com, secondary.com - - * - ``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 ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - example.com, sub.example.com, pointer.com, secondary.com - - Action: ``queryEdit`` --------------------- :Added in Version: 5.1.0-838 :Description: Displays the information available to the action "edit". Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'master_domain' => 'example.com', 'master_domain_ipv4' => '192.168.0.3', 'database_server' => 'localhost', 'reseller' => '1', 'uniqname' => 'example', 'status' => 'active', 'nickname' => 'Example User', 'email' => 'user@example.com', 'encrypted' => 'n', 'password' => NULL, 'confirm_password' => NULL, 'reset_passwords' => array ( ), 'requires_password_change' => '', 'language' => 'en-us', 'theme' => NULL, 'menu_style' => NULL, 'billing_day' => '1', 'additional_ipv4' => array ( 0 => '192.168.0.1', 1 => '192.168.0.3', ), 'ipv6_pool' => '0', 'additional_ipv6' => array ( ), 'php_version' => 'system-php', 'php_available' => array ( 0 => '/opt/remi/php74', 1 => '/opt/remi/php80', 2 => 'system-php', ), '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_MAILMAN' => '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', 'softaculous' => '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_MAILMAN' => 'true', 'LG_OPT_SSL' => 'true', 'LG_OPT_BURSTABLE' => 'true', 'LG_OPT_SAVE_XFER_LOGS' => 'true', ), 'ipaddr' => '192.168.0.3', 'password1' => NULL, 'password2' => NULL, 'package_name' => '__example.com', ), 'reply_code' => 205, ) Action: ``queryIps`` -------------------- :Added in Version: 5.1.0-838 :Description: Displays the information available to the action "ips". Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - example.com - - Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 'domain_copy' => 'example.com', 'domain' => 'example.com', ), 'reply_code' => 205, ) Action: ``querySiteworxAccountDetails`` --------------------------------------- :Added in Version: 4.7.0-339 :Description: Get all SiteWorx account properties of a given domain. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - example.com - - Action: ``querySiteworxAccounts`` --------------------------------- :Added in Version: 4.7.0-339 :Description: Query Siteworx accounts by specifying which properties you want returned. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - struct (string) - No - example.com - - * - ``unixuser`` - struct (string) - No - example - - * - ``account_data`` - struct (string) - No* - 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_mailman, opt_ssl, opt_burstable, opt_save_xfer_logs, all_package_options - ["id","status","domain"] - \* 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 ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - example.com - - * - ``ip`` - struct (string) - Yes - 192.168.0.1 - - 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 ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``query`` - string - No - - - * - ``reseller`` - string - Yes - all, 1, 2 - - Action: ``setConfig`` --------------------- :Added in Version: 6.0.10-1379 :Description: Set SiteWorx Level Config Data. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``master_domain`` - string - Yes - example.com - - * - ``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: ``setDomainConfig`` --------------------------- :Added in Version: 6.4.1-1707 :Description: Set Domain Level Config Data. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - example.com, secondary.com - - * - ``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 ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``login_domain`` - string - Yes - example.com, sub.example.com, pointer.com, secondary.com - - * - ``account_action`` - string - No* - siteworxLogin, edit - siteworxLogin - \* 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 ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - struct (string) - Yes - example.com - - * - ``message`` - string - No - - - This optional message will be displayed to users when they attempt to login to SiteWorx. It will also be visible in NodeWorx. Action: ``suspendByUser`` ------------------------- :Added in Version: 4.8.0-393 :Description: Suspend a SiteWorx account by unix user name. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``user`` - struct (string) - Yes - example - - Action: ``syncServerAlias`` --------------------------- :Added in Version: 4.7.0-339 :Description: Synchronize server aliases with InterWorx database. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - example.com, secondary.com - - * - ``cascade_to_nodes`` - integer - No - 1 - - 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 Action: ``syncVirtualHosts`` ---------------------------- :Added in Version: 4.7.0-339 :Description: Synchronize InterWorx and Apache vitrual host blocks. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - example.com - - * - ``cascade_to_nodes`` - integer - No - 1 - - 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 Action: ``toggleFavorite`` -------------------------- :Added in Version: 4.7.0-339 :Description: Toggle a "favorite" SiteWorx account. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - string - Yes - example.com - - Action: ``unsuspend`` --------------------- :Added in Version: 4.7.0-339 :Description: Unsuspend a SiteWorx account. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``domain`` - struct (string) - Yes - example.com - - Action: ``unsuspendByUser`` --------------------------- :Added in Version: 4.8.0-393 :Description: Unsuspend a SiteWorx account by unix user name. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``user`` - struct (string) - Yes - example - - Action: ``win`` --------------- :Added in Version: n/a :Description: Magic function - test for testing success mechanism.