Controller: ResellerPackages

API Controller	/nodeworx/reseller/packages
Required Permissions	["RESELLER"]

Action	Description
add	Add a Reseller Package.
backup	Backup a reseller package.
delete	Delete a reseller package.
edit	Edit an existing Reseller Package.
import	Import a reseller package.
listDetails	Lists Reseller package details.
~~listIds~~	List reseller packages by id. DEPRECATED in version 4.8.0-393
listResellerPackages	List reseller packages.

Action: add

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 acounts 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 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

Action: backup (Added in version 4.8.3-415)

Backup a reseller package.

Input Parameters

Name	Type	Notes	Required?
id	struct (integer)		Yes

Action: delete

Delete a reseller package.

Input Parameters

Name	Type	Notes	Required?
id	struct (integer)		Yes

Action: edit

Edit an existing Reseller Package.

Input Parameters

Name	Type	Notes	Required?
id	integer		Yes
package_name	string	Example Default Value reseller package unlimited	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 acounts 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 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*
* indicates that it's actually required, but probably already has a valid default value

Action: import (Added in version 4.8.3-415)

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.2.0-260)

Lists Reseller package details.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      'id' => '1',
      'name' => 'reseller package unlimited',
      '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,
    ),
  ),
)

Action: listIds

This action has been deprecated as of version 4.8.0-393.

MESSAGE: 2011-01-25 Use listResellerPackages instead.

List reseller packages by id.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      0 => '1',
      1 => 'reseller package unlimited',
    ),
  ),
)

Action: listResellerPackages (Added in version 4.8.0-393)

List reseller packages.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      'id' => '1',
      'name' => 'reseller package unlimited',
      '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,',
    ),
  ),
)