Chapter 46: Controller: /nodeworx/plugins Up Part II: NodeWorx API Spec Chapter 48: Controller: /nodeworx/reseller/bandwidthhistory 

47 Controller: /nodeworx/reseller

Required Permissions "RESELLER"
Action: add
Added in version 4.7.0-339
Description 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
zh, cs, da, nl, en-us, fr, de, hu, it, pl, pt, ru, sk, es, sv, tr
Example Default Value
en-us
No*
theme string Example Values
blue_steel, calliope, coolfreshness, heliotrope, interstate, interworx, nexcess, vanillaice
Example Default Value
calliope
No*
menu_style string Example Values
big, small
Example Default Value
big
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 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.
Example Values
, Package By Test
No
create_package integer Example Values
1
No
new_package_name string 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 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 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
Example Default Value
1
No*
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
Example Default Value
1
No*
RSL_OPT_THEMES integer Help Entry
Allow users to upload custom interface themes.
Example Values
1, 0
Example Default Value
0
No*
ipv4 struct (string) Example Values
10.1.15.101, 10.1.15.102, 10.1.15.103, 10.1.15.104
No*
ipv6 struct (string) Example Values
2001:db8::d:1101
No
ipv6_pool struct (string) Help Entry
IPv6 Pools allow resellers to assign Pools to their SiteWorx accounts, which in turn assign IPv6 addresses to domains.
Example Values
dead::/64, dead::/24
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: addIp
Added in version 5.0.14-579
Description Adds ips to the list of available IPs for a Reseller account.
Input Parameters
Name Type Notes Required?
reseller_id integer Yes
Action: delete
Added in version 4.7.0-339
Description Delete a reseller account.
Input Parameters
Name Type Notes Required?
reseller_id struct (integer) Yes
Action: edit
Added in version 4.7.0-339
Description Edit a reseller account.
Input Parameters
Name Type Notes Required?
reseller_id integer Yes
nickname string Example Default Value
Reseller Nickname
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
zh, cs, da, nl, en-us, fr, de, hu, it, pl, pt, ru, sk, es, sv, tr
Example Default Value
en-us
No*
theme string Example Values
blue_steel, calliope, coolfreshness, heliotrope, 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 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.
Example Values
, 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_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 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 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*
RSL_OPT_THEMES integer Help Entry
Allow users to upload custom interface themes.
Example Values
1, 0
Example Default Value
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: editIPv6Pools
Added in version 5.0.14-579
Description Change IPv6 Pools the reseller has access to.
Input Parameters
Name Type Notes Required?
reseller_id integer Yes
ipv6_pool struct (string) Help Entry
IPv6 Pools allow resellers to assign Pools to their SiteWorx accounts, which in turn assign IPv6 addresses to domains.
Example Values
dead::/64, dead::/24
Example Default Value
["dead::\/24","dead::\/64"]
No
Action: listDeletableIds
Added in version 4.7.0-339
Description List deletable reseller accounts by id.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
0 => ’16’,
1 => ’Reseller Nickname (reseller@interworx.com)’,
),
),
)
Action: listEditableIds
Added in version 4.7.0-339
Description List editable reseller accounts by id.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
0 => ’16’,
1 => ’Reseller Nickname (reseller@interworx.com)’,
),
),
)
Action: listIds
Added in version 4.7.0-339
Description List reseller accounts by id.
Warning This action has been deprecated as of version 4.8.0-393. 2011-01-24 use listResellersAction
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
0 => ’1’,
1 => ’Server Admin (nodeworx_user@example.com)’,
),
1 =>
array (
0 => ’16’,
1 => ’Reseller Nickname (reseller@interworx.com)’,
),
),
)
Action: listResellers
Added in version 4.8.0-393
Description List all resellers.
Sample 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’ => ’1’,
’storage’ => ’622592’,
),
1 =>
array (
’reseller_id’ => ’16’,
’email’ => ’reseller@interworx.com’,
’nickname’ => ’Reseller Nickname’,
’status’ => ’active’,
’max_bandwidth’ => ’999999999’,
’max_storage’ => ’999999999’,
’max_accounts’ => ’999999999’,
’bandwidth’ => ’0’,
’accounts’ => ’0’,
’storage’ => ’0’,
),
),
)
Action: queryAvailableIps
Added in version 5.0.14-579
Description Displays a payload of IPs available to a reseller.
Input Parameters
Name Type Notes Required?
reseller_id integer No*
* indicates that it’s actually required, but probably already has a valid default value
Action: queryDomains
Added in version 5.1.0-944
Description Show domains on a reseller.
Input Parameters
Name Type Notes Required?
reseller_id integer No*
* indicates that it’s actually required, but probably already has a valid default value
Action: queryEdit
Added in version 5.1.0-838
Description Displays the information available to the action "edit".
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’nickname’ => ’Reseller Nickname’,
’email’ => ’reseller@interworx.com’,
’password’ => NULL,
’confirm_password’ => NULL,
’language’ => ’en-us’,
’theme’ => ’interworx’,
’menu_style’ => ’small’,
’billing_day’ => ’1’,
’status’ => ’active’,
’cascade-status’ => ’0’,
’packagetemplate’ => NULL,
’RSL_OPT_STORAGE’ => ’999999999’,
’RSL_OPT_BANDWIDTH’ => ’999999999’,
’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_OVERSELL_STORAGE’ => ’1’,
’RSL_OPT_OVERSELL_BANDWIDTH’ => ’1’,
’RSL_OPT_THEMES’ => ’1’,
’database_servers’ =>
array (
0 => ’localhost’,
),
’reseller_id’ => ’16’,
’options’ =>
array (
’LG_RSL_OPT_STORAGE’ => ’999999999’,
’LG_RSL_OPT_OVERSELL_STORAGE’ => ’1’,
’LG_RSL_OPT_BANDWIDTH’ => ’999999999’,
’LG_RSL_OPT_OVERSELL_BANDWIDTH’ => ’1’,
’LG_RSL_OPT_EMAIL_ALIASES’ => ’999999999’,
’LG_RSL_OPT_EMAIL_AUTORESPONDERS’ => ’999999999’,
’LG_RSL_OPT_EMAIL_BOXES’ => ’999999999’,
’LG_RSL_OPT_EMAIL_GROUPS’ => ’999999999’,
’LG_RSL_OPT_FTP_ACCOUNTS’ => ’999999999’,
’LG_RSL_OPT_MYSQL_DBS’ => ’999999999’,
’LG_RSL_OPT_MYSQL_DB_USERS’ => ’999999999’,
’LG_RSL_OPT_POINTER_DOMAINS’ => ’999999999’,
’LG_RSL_OPT_SITEWORX_ACCOUNTS’ => ’999999999’,
’LG_RSL_OPT_SLAVE_DOMAINS’ => ’999999999’,
’LG_RSL_OPT_SUBDOMAINS’ => ’999999999’,
’LG_RSL_OPT_THEMES’ => ’1’,
),
’password1’ => NULL,
),
)
Action: queryEditIPv6Pools
Added in version 5.1.0-838
Description Displays the information available to the action "editIPv6Pools".
Input Parameters
Name Type Notes Required?
reseller_id integer Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’ipv6_pool’ =>
array (
0 => ’dead::/24’,
1 => ’dead::/64’,
),
’reseller_id’ => ’1’,
),
)
Action: queryResellerBandwidth
Added in version 4.9.0-427
Description 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.8.0-393
Description Query reseller account details.
Input Parameters
Name Type Notes Required?
reseller string Example Values
reseller@interworx.com
Yes
Action: querySiteworxAccounts
Added in version 5.1.0-944
Description Show siteworx accounts owned by a reseller account.
Input Parameters
Name Type Notes Required?
reseller_id integer No*
* indicates that it’s actually required, but probably already has a valid default value
Action: removeIp
Added in version 5.0.14-579
Description Remove access to an IP from a reseller.
Input Parameters
Name Type Notes Required?
reseller_id integer Yes
ip struct (string) Example Values
10.1.15.101
Yes
 Chapter 46: Controller: /nodeworx/plugins Up Part II: NodeWorx API Spec Chapter 48: Controller: /nodeworx/reseller/bandwidthhistory 

(C) 2017 by InterWorx LLC