Controller: /nodeworx/reseller/packages ======================================= :Required Permissions: RESELLER Action: ``add`` --------------- :Added in Version: 4.7.0-339 :Description: Add a Reseller Package. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``package_name`` - string - Yes - - - * - ``RSL_OPT_STORAGE`` - double - Yes - - - The amount of storage allocated to this reseller - *Megabytes* * - ``RSL_OPT_OVERSELL_STORAGE`` - integer - Yes - 1, 0 - - 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. - *Megabytes* * - ``RSL_OPT_BANDWIDTH`` - double - Yes - - - The amount of bandwidth per month allocated to this reseller - *Gigabytes / Month* * - ``RSL_OPT_OVERSELL_BANDWIDTH`` - integer - Yes - 1, 0 - - 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. - *Gigabytes / Month* * - ``RSL_OPT_EMAIL_ALIASES`` - integer - Yes - - - The number of email aliases (often called email forwards) allowed across all accounts owned by this reseller * - ``RSL_OPT_EMAIL_AUTORESPONDERS`` - integer - Yes - - - The number of email autoresponders, also called robots, allowed across all accounts owned by this reseller * - ``RSL_OPT_EMAIL_BOXES`` - integer - Yes - - - The number of POP3/IMAP email boxes allowed across all accounts owned by this reseller * - ``RSL_OPT_EMAIL_GROUPS`` - integer - Yes - - - The number of group email (aliases that send to multiple recipients) accounts allowed across all accounts owned by this reseller * - ``RSL_OPT_FTP_ACCOUNTS`` - integer - Yes - - - The number of FTP accounts allowed across all accounts owned by this reseller * - ``RSL_OPT_MYSQL_DBS`` - integer - Yes - - - The number of MySQL databases allowed across all accounts owned by this reseller * - ``RSL_OPT_MYSQL_DB_USERS`` - integer - Yes - - - The number of MySQL users allowed across all accounts owned by this reseller * - ``RSL_OPT_POINTER_DOMAINS`` - integer - Yes - - - The number of pointer domains allowed across all accounts owned by this reseller * - ``RSL_OPT_SITEWORX_ACCOUNTS`` - integer - Yes - - - The number of SiteWorx accounts this reseller can create * - ``RSL_OPT_SLAVE_DOMAINS`` - integer - Yes - - - The number of secondary domains allowed across all accounts owned by this reseller * - ``RSL_OPT_SUBDOMAINS`` - integer - Yes - - - The number of subdomains allowed across all accounts owned by this reseller Action: ``backup`` ------------------ :Added in Version: 4.8.3-414 :Description: Backup a reseller package. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``id`` - struct (integer) - Yes - - - Action: ``delete`` ------------------ :Added in Version: 4.7.0-339 :Description: Delete a reseller package. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``id`` - struct (integer) - Yes - - - Action: ``edit`` ---------------- :Added in Version: 4.7.0-339 :Description: Edit an existing Reseller Package. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``id`` - integer - Yes - - - * - ``package_name`` - string - No* - - Package By Test - * - ``RSL_OPT_STORAGE`` - double - No* - - 999999999 - The amount of storage allocated to this reseller - *Megabytes* * - ``RSL_OPT_OVERSELL_STORAGE`` - integer - No* - 1, 0 - 1 - 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. - *Megabytes* * - ``RSL_OPT_BANDWIDTH`` - double - No* - - 999999999 - The amount of bandwidth per month allocated to this reseller - *Gigabytes / Month* * - ``RSL_OPT_OVERSELL_BANDWIDTH`` - integer - No* - 1, 0 - 1 - 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. - *Gigabytes / Month* * - ``RSL_OPT_EMAIL_ALIASES`` - integer - No* - - 999999999 - The number of email aliases (often called email forwards) allowed across all accounts owned by this reseller * - ``RSL_OPT_EMAIL_AUTORESPONDERS`` - integer - No* - - 999999999 - The number of email autoresponders, also called robots, allowed across all accounts owned by this reseller * - ``RSL_OPT_EMAIL_BOXES`` - integer - No* - - 999999999 - The number of POP3/IMAP email boxes allowed across all accounts owned by this reseller * - ``RSL_OPT_EMAIL_GROUPS`` - integer - No* - - 999999999 - The number of group email (aliases that send to multiple recipients) accounts allowed across all accounts owned by this reseller * - ``RSL_OPT_FTP_ACCOUNTS`` - integer - No* - - 999999999 - The number of FTP accounts allowed across all accounts owned by this reseller * - ``RSL_OPT_MYSQL_DBS`` - integer - No* - - 999999999 - The number of MySQL databases allowed across all accounts owned by this reseller * - ``RSL_OPT_MYSQL_DB_USERS`` - integer - No* - - 999999999 - The number of MySQL users allowed across all accounts owned by this reseller * - ``RSL_OPT_POINTER_DOMAINS`` - integer - No* - - 999999999 - The number of pointer domains allowed across all accounts owned by this reseller * - ``RSL_OPT_SITEWORX_ACCOUNTS`` - integer - No* - - 999999999 - The number of SiteWorx accounts this reseller can create * - ``RSL_OPT_SLAVE_DOMAINS`` - integer - No* - - 999999999 - The number of secondary domains allowed across all accounts owned by this reseller * - ``RSL_OPT_SUBDOMAINS`` - integer - No* - - 999999999 - The number of subdomains allowed across all accounts owned by this reseller \* 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: ``import`` ------------------ :Added in Version: 4.8.3-414 :Description: Import a reseller package. Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``package_file`` - string - Yes - - - * - ``overwrite`` - integer - No - 1 - - Action: ``listDetails`` ----------------------- :Added in Version: 4.7.0-339 :Description: Lists Reseller package details. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 'id' => '2', 'name' => 'Package By Test', 'RSL_OPT_STORAGE' => 999999999.0, 'RSL_OPT_OVERSELL_STORAGE' => true, 'RSL_OPT_BANDWIDTH' => 999999999.0, '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, ), ), 'reply_code' => 205, ) 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 ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 0 => '2', 1 => 'Package By Test', ), ), 'reply_code' => 205, ) Action: ``listResellerPackages`` -------------------------------- :Added in Version: 4.8.0-393 :Description: List reseller packages. Sample Output ^^^^^^^^^^^^^ .. code-block:: array ( 'status' => 0, 'payload' => array ( 0 => array ( 'id' => '2', '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,', ), ), 'reply_code' => 205, ) Action: ``queryEdit`` --------------------- :Added in Version: 5.1.0-838 :Description: Displays the information available to the action "edit". Input Parameters ^^^^^^^^^^^^^^^^^ .. list-table:: :widths: auto :header-rows: 1 * - Name - Type - Required? - Example Values - Default Values - Notes * - ``id`` - integer - Yes - - - Sample Output ^^^^^^^^^^^^^ .. code-block:: 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' => '2', ), 'reply_code' => 205, ) Action: ``reroute`` ------------------- :Added in Version: n/a :Description: Action to re-route from the current controller to a different one. Action: ``win`` --------------- :Added in Version: n/a :Description: Magic function - test for testing success mechanism.