Controller: Reseller

API Controller /nodeworx/reseller
Required Permissions ["RESELLER"]
Action Description
add Add a new reseller account.
delete Delete a reseller account.
edit Edit a reseller account.
listDeletableIds List deletable reseller accounts by id.
listEditableIds List editable reseller accounts by id.
listIds List reseller accounts by id. DEPRECATED in version 4.8.0-393
listResellers List all resellers.
queryResellerBandwidth Query Reseller Account bandwidth usage data for any billing period.
queryResellerDetails Query reseller account details.

Action: add

Add a new reseller account.

Input Parameters

Name Type Notes Required?
nickname string No*
email string No*
password string Yes
confirm_password string
Help Entry
Confirm the password field by providing it again. Must match the password provided.
 Yes
language string
Example Values
cs, en-us, fr, de, hu, it, pl, pt, sk, es, sv, tr
Example Default Value
en-us
 No*
theme string
Example Values
blue_steel, calliope, coolfreshness, interstate, interworx, nexcess, vanillaice
Example Default Value
interworx
 No*
menu_style string
Example Values
big, small
Example Default Value
small
 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*
status string
Example Values
active, inactive
 Yes
packagetemplate string
Help Entry
A package template is a blueprint for the package to setup. You don't have to use a package template but it is often easier to use one so you don't have to specify all options every time you setup a SiteWorx account.
Example Values
, reseller package unlimited
 No
RSL_OPT_STORAGE double
Description
Megabytes
Help Entry
The amount of storage allocated to this reseller
 Yes
RSL_OPT_BANDWIDTH double
Description
Gigabytes / Month
Help Entry
The amount of bandwidth per month allocated to this reseller
 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
RSL_OPT_OVERSELL_STORAGE integer
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_OVERSELL_BANDWIDTH integer
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
ips struct (string)
Help Entry
The IP address list shows you the current IP addresses that are available on your server.
Example Values
123.123.123.123, 123.123.123.125
 No*
database_servers struct (string)
Help Entry
Select the database server from the list that you would like to use.
Example Values
localhost
Example Default Value
["localhost"]
 No*
* indicates that it's actually required, but probably already has a valid default value

Action: delete

Delete a reseller account.

Input Parameters

Name Type Notes Required?
reseller_id struct (integer) Yes

Action: edit

Edit a reseller account.

Input Parameters

Name Type Notes Required?
reseller_id integer Yes
nickname string
Example Default Value
Jon Reseller
 No*
email string
Example Default Value
reseller@interworx.com
 No*
password string No
confirm_password string
Help Entry
Confirm the password field by providing it again. Must match the password provided.
 No
language string
Example Values
cs, en-us, fr, de, hu, it, pl, pt, sk, es, sv, tr
Example Default Value
en-us
 No*
theme string
Example Values
blue_steel, calliope, coolfreshness, interstate, interworx, nexcess, vanillaice
Example Default Value
interworx
 No*
menu_style string
Example Values
big, small
Example Default Value
small
 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*
status string
Example Values
active, inactive
Example Default Value
active
 No*
cascade-status integer
Example Values
1, 0
Example Default Value
0
 No*
packagetemplate string
Help Entry
A package template is a blueprint for the package to setup. You don't have to use a package template but it is often easier to use one so you don't have to specify all options every time you setup a SiteWorx account.
Example Values
, 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_BANDWIDTH double
Description
Gigabytes / Month
Help Entry
The amount of bandwidth per month allocated to this reseller
Example Default Value
999999999
 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*
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_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*
ips struct (string)
Help Entry
The IP address list shows you the current IP addresses that are available on your server.
Example Values
208.69.122.234, 4.3.2.1, 123.123.123.123, 123.123.123.125
Example Default Value
["208.69.122.234","4.3.2.1"]
 No*
database_servers struct (string)
Help Entry
Select the database server from the list that you would like to use.
Example Values
localhost
Example Default Value
["localhost"]
 No*
* indicates that it's actually required, but probably already has a valid default value

Action: listDeletableIds

List deletable reseller accounts by id.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      0 => '2',
      1 => 'Jon Reseller (reseller@interworx.com)',
    ),
  ),
)

Action: listEditableIds

List editable reseller accounts by id.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      0 => '2',
      1 => 'Jon Reseller (reseller@interworx.com)',
    ),
  ),
)

Action: listIds

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

MESSAGE: 2011-01-24 use listResellersAction

List reseller accounts by id.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      0 => '1',
      1 => 'Server Admin (nodeworx_user@example.com)',
    ),
    1 => 
    array (
      0 => '2',
      1 => 'Jon Reseller (reseller@interworx.com)',
    ),
  ),
)

Action: listResellers (Added in version 4.7.2-359)

List all resellers.

Example Output

array (
  'status' => 0,
  'payload' => 
  array (
    0 => 
    array (
      'reseller_id' => '1',
      'email' => 'nodeworx_user@example.com',
      'nickname' => 'Server Admin',
      'status' => 'active',
      'max_bandwidth' => '999999999',
      'max_storage' => '999999999',
      'max_accounts' => '999999999',
      'bandwidth' => '0',
      'accounts' => '2',
      'storage' => '16859136',
    ),
    1 => 
    array (
      'reseller_id' => '2',
      'email' => 'reseller@interworx.com',
      'nickname' => 'Jon Reseller',
      'status' => 'active',
      'max_bandwidth' => '999999999',
      'max_storage' => '999999999',
      'max_accounts' => '999999999',
      'bandwidth' => NULL,
      'accounts' => '0',
      'storage' => NULL,
    ),
  ),
)

Action: queryResellerBandwidth (Added in version 4.9.0-426)

Query Reseller Account bandwidth usage data for any billing period.

Input Parameters

Name Type Notes Required?
resellers struct (string)
Help Entry
Select resellers to view bandwidth data for. Selecting none is the same as selecting all.
Example Values
reseller@interworx.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: queryResellerDetails (Added in version 4.7.2-359)

Query reseller account details.

Input Parameters

Name Type Notes Required?
reseller string
Example Values
reseller@interworx.com
 Yes