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 |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
No* |
|||
|
string |
No* |
|||
|
string |
No* |
y, n |
n |
“y” if the password is ALREADY encrypted, “n” if the password is not yet encrypted. Default: n |
|
string |
Yes |
|||
|
string |
Yes |
Confirm the password field by providing it again. Must match the password provided. |
||
|
integer |
No |
1 |
If selected, the next time this user logs in via the web, they will be forced to change their password before doing anything else. |
|
|
string |
No* |
cs, da, de, en-us, es, fr, hu, it, nl, pl, pt, ru, sk, sv, tr, zh |
en-us |
|
|
string |
No |
|||
|
string |
No |
|||
|
integer |
No* |
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 |
1 |
The billing day is the day of the month (1-31) that this reseller’s monthly bandwidth calculation will start back at 0. |
|
string |
Yes |
active, inactive |
||
|
integer |
No |
1 |
This reseller account will be setup with the nameservers currently defined in the master NodeWorx account. |
|
|
string |
No |
Package By Test |
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. |
|
|
integer |
No |
1 |
||
|
string |
No |
|||
|
double |
Yes |
The amount of storage allocated to this reseller - Megabytes |
||
|
double |
Yes |
The amount of bandwidth per month allocated to this reseller - Gigabytes / Month |
||
|
integer |
Yes |
The number of email aliases (often called email forwards) allowed across all accounts owned by this reseller |
||
|
integer |
Yes |
The number of email autoresponders, also called robots, allowed across all accounts owned by this reseller |
||
|
integer |
Yes |
The number of POP3/IMAP email boxes allowed across all accounts owned by this reseller |
||
|
integer |
Yes |
The number of group email (aliases that send to multiple recipients) accounts allowed across all accounts owned by this reseller |
||
|
integer |
Yes |
The number of FTP accounts allowed across all accounts owned by this reseller |
||
|
integer |
Yes |
The number of MySQL databases allowed across all accounts owned by this reseller |
||
|
integer |
Yes |
The number of MySQL users allowed across all accounts owned by this reseller |
||
|
integer |
Yes |
The number of pointer domains allowed across all accounts owned by this reseller |
||
|
integer |
Yes |
The number of SiteWorx accounts this reseller can create |
||
|
integer |
Yes |
The number of secondary domains allowed across all accounts owned by this reseller |
||
|
integer |
Yes |
The number of subdomains allowed across all accounts owned by this reseller |
||
|
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. |
|
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. |
|
struct (string) |
No |
2001::/64, 2001::/24 |
IPv6 Pools allow resellers to assign Pools to their SiteWorx accounts, which in turn assign IPv6 addresses to domains. |
|
|
struct (string) |
No* |
localhost, remote_db |
[“localhost”] |
Select the database server from the list that you would like to use. |
* 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 |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
Yes |
Action: delete
¶
- Added in Version
4.7.0-339
- Description
Delete a reseller account.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
struct (integer) |
Yes |
Action: edit
¶
- Added in Version
4.7.0-339
- Description
Edit a reseller account.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
Yes |
|||
|
string |
No* |
Reseller Nickname |
||
|
string |
No* |
|||
|
string |
No |
|||
|
integer |
No |
1 |
If selected, the next time this user logs in via the web, they will be forced to change their password before doing anything else. |
|
|
string |
No |
Confirm the password field by providing it again. Must match the password provided. |
||
|
string |
No* |
y, n |
n |
“y” if the password is ALREADY encrypted, “n” if the password is not yet encrypted. Default: n |
|
string |
No* |
cs, da, de, en-us, es, fr, hu, it, nl, pl, pt, ru, sk, sv, tr, zh |
en-us |
|
|
string |
No |
|||
|
string |
No |
|||
|
integer |
No* |
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 |
1 |
The billing day is the day of the month (1-31) that this reseller’s monthly bandwidth calculation will start back at 0. |
|
string |
No* |
active, inactive |
active |
|
|
integer |
No* |
1, 0 |
0 |
|
|
string |
No |
Package By Test |
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. |
|
|
double |
No* |
999999999 |
The amount of storage allocated to this reseller - Megabytes |
|
|
double |
No* |
999999999 |
The amount of bandwidth per month allocated to this reseller - Gigabytes / Month |
|
|
integer |
No* |
999999999 |
The number of email aliases (often called email forwards) allowed across all accounts owned by this reseller |
|
|
integer |
No* |
999999999 |
The number of email autoresponders, also called robots, allowed across all accounts owned by this reseller |
|
|
integer |
No* |
999999999 |
The number of POP3/IMAP email boxes allowed across all accounts owned by this reseller |
|
|
integer |
No* |
999999999 |
The number of group email (aliases that send to multiple recipients) accounts allowed across all accounts owned by this reseller |
|
|
integer |
No* |
999999999 |
The number of FTP accounts allowed across all accounts owned by this reseller |
|
|
integer |
No* |
999999999 |
The number of MySQL databases allowed across all accounts owned by this reseller |
|
|
integer |
No* |
999999999 |
The number of MySQL users allowed across all accounts owned by this reseller |
|
|
integer |
No* |
999999999 |
The number of pointer domains allowed across all accounts owned by this reseller |
|
|
integer |
No* |
999999999 |
The number of SiteWorx accounts this reseller can create |
|
|
integer |
No* |
999999999 |
The number of secondary domains allowed across all accounts owned by this reseller |
|
|
integer |
No* |
999999999 |
The number of subdomains allowed across all accounts owned by this reseller |
|
|
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 |
|
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 |
|
struct (string) |
No* |
localhost, remote_db |
[“localhost”] |
Select the database server from the list that you would like to use. |
* 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 |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
Yes |
|||
|
struct (string) |
No |
2001::/64, 2001::/24 |
[“2001::/24”,”2001::/64”] |
IPv6 Pools allow resellers to assign Pools to their SiteWorx accounts, which in turn assign IPv6 addresses to domains. |
Action: fail
¶
- Added in Version
n/a
- Description
Magic function - test for failure mechanism.
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 => '2',
1 => 'Reseller Nickname ([email protected])',
),
),
'reply_code' => 205,
)
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 => '2',
1 => 'Reseller Nickname ([email protected])',
),
),
'reply_code' => 205,
)
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 ([email protected])',
),
1 =>
array (
0 => '2',
1 => 'Reseller Nickname ([email protected])',
),
),
'reply_code' => 205,
)
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' => '[email protected]',
'nickname' => 'Server Admin',
'status' => 'active',
'max_bandwidth' => '999999999',
'max_storage' => '999999999',
'max_accounts' => '999999999',
'bandwidth' => '0',
'accounts' => '1',
'storage' => '0',
),
1 =>
array (
'reseller_id' => '2',
'email' => '[email protected]',
'nickname' => 'Reseller Nickname',
'status' => 'active',
'max_bandwidth' => '999999999',
'max_storage' => '999999999',
'max_accounts' => '999999999',
'bandwidth' => '0',
'accounts' => '0',
'storage' => '0',
),
),
'reply_code' => 205,
)
Action: queryAvailableIps
¶
- Added in Version
5.0.14-579
- Description
Displays a payload of IPs available to a reseller.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
No* |
* indicates that it’s actually required, but probably already has a valid default value.
Action: queryDomains
¶
- Added in Version
5.1.0-941
- Description
Show domains on a reseller.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
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' => '[email protected]',
'password' => NULL,
'requires_password_change' => '',
'confirm_password' => NULL,
'encrypted' => 'n',
'language' => 'en-us',
'menu_style' => NULL,
'theme' => NULL,
'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',
'database_servers' =>
array (
0 => 'localhost',
),
'reseller_id' => '2',
'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',
),
'password1' => NULL,
),
'reply_code' => 205,
)
Action: queryEditIPv6Pools
¶
- Added in Version
5.1.0-838
- Description
Displays the information available to the action “editIPv6Pools”.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
Yes |
Sample Output¶
array (
'status' => 0,
'payload' =>
array (
'ipv6_pool' =>
array (
0 => '2001::/24',
1 => '2001::/64',
),
'reseller_id' => '1',
),
'reply_code' => 205,
)
Action: queryResellerBandwidth
¶
- Added in Version
4.9.0-427
- Description
Query Reseller Account bandwidth usage data for any billing period.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
struct (string) |
No |
Select resellers to view bandwidth data for. Selecting none is the same as selecting all. |
||
|
integer |
No |
A Unix Timestamp to identify the billing period from which the bandwidth data will be shown. If blank, defaults to the current time. |
Action: queryResellerDetails
¶
- Added in Version
4.8.0-393
- Description
Query reseller account details.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
Action: querySiteworxAccounts
¶
- Added in Version
5.1.0-941
- Description
Show siteworx accounts owned by a reseller account.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
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 |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
Yes |
|||
|
struct (integer) |
Yes |
Action: reroute
¶
- Added in Version
n/a
- Description
Action to re-route from the current controller to a different one.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
Index, Overview, Users, Lang, Apikey, Plugins, Twofactorauth, Notice, Siteworx, Shell, Packages, Backup, Import, Softaculous, Reseller, ResellerPackages, ResellerBandwidthhistory, Http, Phpextensions, Ftp, Sshd, MailMta, MailSmtp, MailSmtp2, MailSend, MailMda, MailMsa, MailDovecot, MailSpam, MailVirus, MailMailman, MailQueue, Mysql, MysqlRemote, MysqlPhpmyadmin, Dns, DnsZone, DnsRecord, DnsSync, Nfs, NfsExport, NfsMount, Health, Cron, Firewall, Ssl, Logs, Settings, Updates, Rrd, … |
Action: win
¶
- Added in Version
n/a
- Description
Magic function - test for testing success mechanism.