Help Entry The amount of storage space allowed in megabytes
Yes
OPT_BANDWIDTH
double
Description Gigabytes / Month
Help Entry The amount of bandwidth allowed per month in gigabytes
Yes
OPT_EMAIL_ALIASES
integer
Help Entry The number of e-mail aliases (often called e-mail forwards) allowed
Yes
OPT_EMAIL_AUTORESPONDERS
integer
Help Entry The number of e-mail autoresponders, also called robots, allowed
Yes
OPT_EMAIL_BOXES
integer
Help Entry The number of POP3/IMAP e-mail boxes allowed
Yes
OPT_EMAIL_GROUPS
integer
Help Entry The number of group e-mail (aliases that send to multiple recipients) accounts allowed
Yes
OPT_FTP_ACCOUNTS
integer
Help Entry The number of FTP accounts allowed
Yes
OPT_MYSQL_DBS
integer
Help Entry The number of MySQL databases allowed
Yes
OPT_MYSQL_DB_USERS
integer
Help Entry The number of MySQL users allowed
Yes
OPT_POINTER_DOMAINS
integer
Help Entry The number of domains that can be pointed to this domain. Sometimes called "parked" domains.
Yes
OPT_SLAVE_DOMAINS
integer
Help Entry The number of secondary domains allowed. Sometimes called "add-on" domains.
Yes
OPT_SUBDOMAINS
integer
Help Entry The number of subdomains allowed
Yes
OPT_BACKUP
integer
Help Entry Enables the ability to backup the account
Example Values 1, 0
Yes
OPT_CGI_ACCESS
integer
Help Entry Indicator of whether or not CGI script access is enabled
Example Values 1, 0
Yes
OPT_CRONTAB
integer
Help Entry Access to Crontab
Example Values 1, 0
Yes
OPT_DNS_RECORDS
integer
Help Entry If yes, the SiteWorx account will be able to edit its own DNS records. (MX, SPF, and Domainkeys records are not effected by this setting)
Example Values 1, 0
Yes
OPT_RESOLVE_XFERLOG_DNS
integer
Help Entry If you choose to resolve DNS name, your statistics will reflect human readable domain names rather than numeric ip addresses.
Example Values 1, 0
Yes
OPT_SSL
integer
Help Entry Enable SSL Certificates
Example Values 1, 0
Yes
OPT_BURSTABLE
integer
Help Entry If you choose to be "burstable" your site will be able to go over its bandwidth allotment, perhaps at an extra cost (depending on the agreement). If you choose no, your bandwidth will be capped at a predefined limit and you will not be able to transfer any more data once the transfer limit is reached.
Example Values 1, 0
Yes
OPT_SAVE_XFER_LOGS
integer
Help Entry If you answer yes to saving the transfer logs, the transfer logs will be saved in a format that can be downloaded. If you answer no, your logs are not saved and can not be downloaded and analyzed offline.
Example Values 1, 0
Yes
Action: backup (Added in version 4.8.3-415)
Backup a siteworx package.
Input Parameters
Name
Type
Notes
Required?
id
struct (integer)
Yes
Action: delete
Delete a siteworx package.
Input Parameters
Name
Type
Notes
Required?
id
struct (integer)
Yes
Action: edit
Edit a siteworx package.
Input Parameters
Name
Type
Notes
Required?
id
integer
Yes
package_name
string
Example Default Value hosting package one
No*
OPT_STORAGE
double
Description Megabytes
Help Entry The amount of storage space allowed in megabytes
Example Default Value 100
No*
OPT_BANDWIDTH
double
Description Gigabytes / Month
Help Entry The amount of bandwidth allowed per month in gigabytes
Example Default Value 100
No*
OPT_EMAIL_ALIASES
integer
Help Entry The number of e-mail aliases (often called e-mail forwards) allowed
Example Default Value 100
No*
OPT_EMAIL_AUTORESPONDERS
integer
Help Entry The number of e-mail autoresponders, also called robots, allowed
Example Default Value 100
No*
OPT_EMAIL_BOXES
integer
Help Entry The number of POP3/IMAP e-mail boxes allowed
Example Default Value 100
No*
OPT_EMAIL_GROUPS
integer
Help Entry The number of group e-mail (aliases that send to multiple recipients) accounts allowed
Example Default Value 999999999
No*
OPT_FTP_ACCOUNTS
integer
Help Entry The number of FTP accounts allowed
Example Default Value 999999999
No*
OPT_MYSQL_DBS
integer
Help Entry The number of MySQL databases allowed
Example Default Value 999999999
No*
OPT_MYSQL_DB_USERS
integer
Help Entry The number of MySQL users allowed
Example Default Value 999999999
No*
OPT_POINTER_DOMAINS
integer
Help Entry The number of domains that can be pointed to this domain. Sometimes called "parked" domains.
Example Default Value 999999999
No*
OPT_SLAVE_DOMAINS
integer
Help Entry The number of secondary domains allowed. Sometimes called "add-on" domains.
Example Default Value 999999999
No*
OPT_SUBDOMAINS
integer
Help Entry The number of subdomains allowed
Example Default Value 999999999
No*
OPT_BACKUP
integer
Help Entry Enables the ability to backup the account
Example Values 1, 0
Example Default Value 1
No*
OPT_CGI_ACCESS
integer
Help Entry Indicator of whether or not CGI script access is enabled
Example Values 1, 0
Example Default Value 1
No*
OPT_CRONTAB
integer
Help Entry Access to Crontab
Example Values 1, 0
Example Default Value 1
No*
OPT_DNS_RECORDS
integer
Help Entry If yes, the SiteWorx account will be able to edit its own DNS records. (MX, SPF, and Domainkeys records are not effected by this setting)
Example Values 1, 0
Example Default Value 0
No*
OPT_RESOLVE_XFERLOG_DNS
integer
Help Entry If you choose to resolve DNS name, your statistics will reflect human readable domain names rather than numeric ip addresses.
Example Values 1, 0
Example Default Value 1
No*
OPT_SSL
integer
Help Entry Enable SSL Certificates
Example Values 1, 0
Example Default Value 1
No*
OPT_BURSTABLE
integer
Help Entry If you choose to be "burstable" your site will be able to go over its bandwidth allotment, perhaps at an extra cost (depending on the agreement). If you choose no, your bandwidth will be capped at a predefined limit and you will not be able to transfer any more data once the transfer limit is reached.
Example Values 1, 0
Example Default Value 1
No*
OPT_SAVE_XFER_LOGS
integer
Help Entry If you answer yes to saving the transfer logs, the transfer logs will be saved in a format that can be downloaded. If you answer no, your logs are not saved and can not be downloaded and analyzed offline.
Example Values 1, 0
Example Default Value 1
No*
* indicates that it's actually required, but probably already has a valid default value
Controller: Packages
listIdsAction: add
Add a siteworx package.
Input Parameters
Megabytes
The amount of storage space allowed in megabytes
Gigabytes / Month
The amount of bandwidth allowed per month in gigabytes
The number of e-mail aliases (often called e-mail forwards) allowed
The number of e-mail autoresponders, also called robots, allowed
The number of POP3/IMAP e-mail boxes allowed
The number of group e-mail (aliases that send to multiple recipients) accounts allowed
The number of FTP accounts allowed
The number of MySQL databases allowed
The number of MySQL users allowed
The number of domains that can be pointed to this domain. Sometimes called "parked" domains.
The number of secondary domains allowed. Sometimes called "add-on" domains.
The number of subdomains allowed
Enables the ability to backup the account
1, 0
Indicator of whether or not CGI script access is enabled
1, 0
Access to Crontab
1, 0
If yes, the SiteWorx account will be able to edit its own DNS records. (MX, SPF, and Domainkeys records are not effected by this setting)
1, 0
If you choose to resolve DNS name, your statistics will reflect human readable domain names rather than numeric ip addresses.
1, 0
Enable SSL Certificates
1, 0
If you choose to be "burstable" your site will be able to go over its bandwidth allotment, perhaps at an extra cost (depending on the agreement). If you choose no, your bandwidth will be capped at a predefined limit and you will not be able to transfer any more data once the transfer limit is reached.
1, 0
If you answer yes to saving the transfer logs, the transfer logs will be saved in a format that can be downloaded. If you answer no, your logs are not saved and can not be downloaded and analyzed offline.
1, 0
Action: backup (Added in version 4.8.3-415)
Backup a siteworx package.
Input Parameters
Action: delete
Delete a siteworx package.
Input Parameters
Action: edit
Edit a siteworx package.
Input Parameters
hosting package one
Megabytes
The amount of storage space allowed in megabytes
100
Gigabytes / Month
The amount of bandwidth allowed per month in gigabytes
100
The number of e-mail aliases (often called e-mail forwards) allowed
100
The number of e-mail autoresponders, also called robots, allowed
100
The number of POP3/IMAP e-mail boxes allowed
100
The number of group e-mail (aliases that send to multiple recipients) accounts allowed
999999999
The number of FTP accounts allowed
999999999
The number of MySQL databases allowed
999999999
The number of MySQL users allowed
999999999
The number of domains that can be pointed to this domain. Sometimes called "parked" domains.
999999999
The number of secondary domains allowed. Sometimes called "add-on" domains.
999999999
The number of subdomains allowed
999999999
Enables the ability to backup the account
1, 0
1
Indicator of whether or not CGI script access is enabled
1, 0
1
Access to Crontab
1, 0
1
If yes, the SiteWorx account will be able to edit its own DNS records. (MX, SPF, and Domainkeys records are not effected by this setting)
1, 0
0
If you choose to resolve DNS name, your statistics will reflect human readable domain names rather than numeric ip addresses.
1, 0
1
Enable SSL Certificates
1, 0
1
If you choose to be "burstable" your site will be able to go over its bandwidth allotment, perhaps at an extra cost (depending on the agreement). If you choose no, your bandwidth will be capped at a predefined limit and you will not be able to transfer any more data once the transfer limit is reached.
1, 0
1
If you answer yes to saving the transfer logs, the transfer logs will be saved in a format that can be downloaded. If you answer no, your logs are not saved and can not be downloaded and analyzed offline.
1, 0
1
Action: import (Added in version 4.8.3-415)
Import a siteworx package.
Input Parameters
1
Action: listDetails (Added in version 4.2.0-260)
Lists SiteWorx package details.
Example Output
array ( 'status' => 0, 'payload' => array ( 0 => array ( 'id' => '7', 'name' => 'hosting package one', 'OPT_STORAGE' => 100, 'OPT_BANDWIDTH' => 100, 'OPT_EMAIL_ALIASES' => 100, 'OPT_EMAIL_AUTORESPONDERS' => 100, 'OPT_EMAIL_BOXES' => 100, 'OPT_EMAIL_GROUPS' => 999999999, 'OPT_FTP_ACCOUNTS' => 999999999, 'OPT_MYSQL_DBS' => 999999999, 'OPT_MYSQL_DB_USERS' => 999999999, 'OPT_POINTER_DOMAINS' => 999999999, 'OPT_SLAVE_DOMAINS' => 999999999, 'OPT_SUBDOMAINS' => 999999999, 'OPT_BACKUP' => true, 'OPT_CGI_ACCESS' => true, 'OPT_CRONTAB' => true, 'OPT_DNS_RECORDS' => false, 'OPT_RESOLVE_XFERLOG_DNS' => true, 'OPT_SSL' => true, 'OPT_BURSTABLE' => true, 'OPT_SAVE_XFER_LOGS' => true, ), ), )Action: listIds
MESSAGE: 2011-01-18 Use listPackages instead
List SiteWorx packages by id.
Example Output
array ( 'status' => 0, 'payload' => array ( 0 => array ( 0 => '7', 1 => 'hosting package one', ), ), )Action: listPackages (Added in version 4.8.0-393)
List SiteWorx Packages.
Example Output
array ( 'status' => 0, 'payload' => array ( 0 => array ( 'id' => '7', 'name' => 'hosting package one', 'options' => 'OPT_STORAGE=100,OPT_BANDWIDTH=100,OPT_EMAIL_ALIASES=100,OPT_EMAIL_AUTORESPONDERS=100,OPT_EMAIL_BOXES=100,OPT_EMAIL_GROUPS=999999999,OPT_FTP_ACCOUNTS=999999999,OPT_MYSQL_DBS=999999999,OPT_MYSQL_DB_USERS=999999999,OPT_POINTER_DOMAINS=999999999,OPT_SLAVE_DOMAINS=999999999,OPT_SUBDOMAINS=999999999,OPT_BACKUP=1,OPT_CGI_ACCESS=1,OPT_CRONTAB=1,OPT_DNS_RECORDS=,OPT_RESOLVE_XFERLOG_DNS=1,OPT_SSL=1,OPT_BURSTABLE=1,OPT_SAVE_XFER_LOGS=1,', ), ), )