Chapter 48: Controller: /nodeworx/reseller/bandwidthhistory Up Part II: NodeWorx API Spec Chapter 50: Controller: /nodeworx/settings 

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’,
),
)
 Chapter 48: Controller: /nodeworx/reseller/bandwidthhistory Up Part II: NodeWorx API Spec Chapter 50: Controller: /nodeworx/settings 

(C) 2017 by InterWorx LLC