Skip to content
ATTENTION
You are viewing the documentation of the current development state (git-main / nightly).
The current latest stable documentation can be found here.

HostingPlans

HostingPlans.listing

list all available hosting plans

Permission

admin

Parameter

FieldTypeDescription
sql_searcharrayoptional array with index = fieldname, and value = array with 'op' => operator (one of <, > or =),LIKE is used if left empty and 'value' => searchvalue
sql_limitintoptional specify number of results to be returned
sql_offsetintoptional specify offset for resultset
sql_orderbyarrayoptional array with index = fieldname and value = ASC|DESC to order the resultset by one or morefields

Response

string as json-encoded array count|list

HostingPlans.listingCount

returns the total number of accessible hosting plans

Permission

admin

Response

string as json-encoded response message

HostingPlans.add

add new hosting-plan

Permission

admin

Parameter

FieldTypeDescription
namestringname of the plan
descriptionstringoptional, description for hosting-plan
diskspaceintoptional disk-space available for customer in MB, default 0
diskspace_ulbooloptional, whether customer should have unlimited diskspace, default 0 (false)
trafficintoptional traffic available for customer in GB, default 0
traffic_ulbooloptional, whether customer should have unlimited traffic, default 0 (false)
subdomainsintoptional amount of subdomains available for customer, default 0
subdomains_ulbooloptional, whether customer should have unlimited subdomains, default 0 (false)
emailsintoptional amount of emails available for customer, default 0
emails_ulbooloptional, whether customer should have unlimited emails, default 0 (false)
email_accountsintoptional amount of email-accounts available for customer, default 0
email_accounts_ulbooloptional, whether customer should have unlimited email-accounts, default 0 (false)
email_forwardersintoptional amount of email-forwarders available for customer, default 0
email_forwarders_ulbooloptional, whether customer should have unlimited email-forwarders, default 0 (false)
email_quotaintoptional size of email-quota available for customer in MB, default is system-setting mail_quota
email_quota_ulbooloptional, whether customer should have unlimited email-quota, default 0 (false)
email_imapbooloptional, whether to allow IMAP access, default 0 (false)
email_pop3booloptional, whether to allow POP3 access, default 0 (false)
ftpsintoptional amount of ftp-accounts available for customer, default 0
ftps_ulbooloptional, whether customer should have unlimited ftp-accounts, default 0 (false)
mysqlsintoptional amount of mysql-databases available for customer, default 0
mysqls_ulbooloptional, whether customer should have unlimited mysql-databases, default 0 (false)
phpenabledbooloptional, whether to allow usage of PHP, default 0 (false)
allowed_phpconfigsarrayoptional, array of IDs of php-config that the customer is allowed to use, default empty (none)
perlenabledbooloptional, whether to allow usage of Perl/CGI, default 0 (false)
dnsenabledbooloptional, whether to allow usage of the DNS editor (requires activated nameserver in settings),default 0 (false)
logviewenabledbooloptional, whether to allow access to webserver access/error-logs, default 0 (false)

Response

string as json-encoded array

HostingPlans.get

return a hosting-plan entry by either id or plan-name

Permission

admin

Parameter

FieldTypeDescription
idintoptional, the hosting-plan-id
plannamestringoptional, the hosting-plan-name

Response

string as json-encoded array

HostingPlans.update

update hosting-plan by either id or plan-name

Permission

admin

Parameter

FieldTypeDescription
idintoptional the hosting-plan-id
plannamestringoptional the hosting-plan-name
namestringoptional name of the plan
descriptionstringoptional description for hosting-plan
diskspaceintoptional disk-space available for customer in MB, default 0
diskspace_ulbooloptional, whether customer should have unlimited diskspace, default 0 (false)
trafficintoptional traffic available for customer in GB, default 0
traffic_ulbooloptional, whether customer should have unlimited traffic, default 0 (false)
subdomainsintoptional amount of subdomains available for customer, default 0
subdomains_ulbooloptional, whether customer should have unlimited subdomains, default 0 (false)
emailsintoptional amount of emails available for customer, default 0
emails_ulbooloptional, whether customer should have unlimited emails, default 0 (false)
email_accountsintoptional amount of email-accounts available for customer, default 0
email_accounts_ulbooloptional, whether customer should have unlimited email-accounts, default 0 (false)
email_forwardersintoptional amount of email-forwarders available for customer, default 0
email_forwarders_ulbooloptional, whether customer should have unlimited email-forwarders, default 0 (false)
email_quotaintoptional size of email-quota available for customer in MB, default is system-setting mail_quota
email_quota_ulbooloptional, whether customer should have unlimited email-quota, default 0 (false)
email_imapbooloptional, whether to allow IMAP access, default 0 (false)
email_pop3booloptional, whether to allow POP3 access, default 0 (false)
ftpsintoptional amount of ftp-accounts available for customer, default 0
ftps_ulbooloptional, whether customer should have unlimited ftp-accounts, default 0 (false)
mysqlsintoptional amount of mysql-databases available for customer, default 0
mysqls_ulbooloptional, whether customer should have unlimited mysql-databases, default 0 (false)
phpenabledbooloptional, whether to allow usage of PHP, default 0 (false)
allowed_phpconfigsarrayoptional, array of IDs of php-config that the customer is allowed to use, default empty (none)
perlenabledbooloptional, whether to allow usage of Perl/CGI, default 0 (false)
dnsenabledbooloptional, either to allow usage of the DNS editor (requires activated nameserver in settings),default 0 (false)
logviewenabledbooloptional, either to allow access to webserver access/error-logs, default 0 (false)

Response

string as json-encoded array

HostingPlans.delete

delete hosting-plan by either id or plan-name

Permission

admin

Parameter

FieldTypeDescription
idintoptional the hosting-plan-id
plannamestringoptional the hosting-plan-name

Response

string as json-encoded array