The page contains an automatically generated description of the API functions. The actual function and parameter names depend on the specific configuration of the control panel.To get the exact name of the function and its parameters, perform the required action through the interface and view the entries in the log file of the control panel.
The list object's parameters or additional query parameters (see above):
required_score — Required score. Specify scores that will be used to tag letters as spam. Anything above the said score will be marked as spam.
rewrite_subject — Add to the "Subject" field. With this option set, the letter will be tagged as spam. The text that you have provided will be added into the Subject field. If there is no such a parameter, the Subject filed will remain unchanged
report_safe — Report type. Select a filter report type
report_contact — Contact email. Enter an email address of the mail server administrator. It is provided in the spam report
The list object's parameters or additional query parameters (see above):
limit_cl_cpu — CPU load limit. Percentage of CPU utilization that occurred while executing at the user level.
limit_cl_nproc — Total number of processes. Enter the total number of processes allocated to each user
limit_cl_pmem — Physical memory. Enter the maximum amount of physical memory allocated to this user. Shared memory and disk cache used by user processes are also counted
limit_cl_io — I/O limit. I/O limit
limit_cl_maxentryprocs — LVE concurrent connections . Enter the maximum number of entries into LVE. We don't count processes that are already created
dbgovernor — . (Optional parameter. To enable the option click "on".) Use MySQL Governor to manage MySQL servers usage
gv_l_current_cpu — CPU load. The maximum CPU load. If the user hits the limit, LVE limits will be applied to the MySQL user. Values from 1 to 100
gv_l_current_read — Read . The maximum amount of data that can be read from disk. If the MySQL user hits this limit, LVE limits will be applied
gv_l_current_write — Write. The maximum amount of data that can be written to disk. If the MySQL user hits this limit, LVE limits will be applied
gv_l_short_cpu — CPU load. The maximum CPU load. Once exceeded, LVE limits will be applied to the MySQL user. Values from 1 to 100
gv_l_short_read — Read. The maximum amount of data that can be read from disk. If the MySQL user hits this limit, LVE limits will be applied
gv_l_short_write — Write. The maximum amount of data that can be written to disk. If the MySQL user hits this limit, LVE limits will be applied
gv_l_mid_cpu — CPU load. The maximum CPU load. If the user hits the limit, LVE limits will be applied to the MySQL user. Values from 1 to 100
gv_l_mid_read — Write. The maximum amount of data that can be read from disk. If the MySQL user hits this limit, LVE limits will be applied
gv_l_mid_write — Write. The maximum amount of data that can be written to disk. If the MySQL user hits this limit, LVE limits will be applied
gv_l_long_cpu — CPU load. The maximum CPU load. If the user hits the limit, LVE limits will be applied to the MySQL user. Values from 1 to 100
gv_l_long_read — Read . The maximum amount of data that can be read from disk. If the MySQL user hits this limit, LVE limits will be applied
gv_l_long_write — Write . The maximum amount of data that can be written to disk. If the MySQL user hits this limit, LVE limits will be applied
storage — Storage. List of storages where backup copies will be stored
rewrite_today — . (Optional parameter. To enable the option click "on".) Only the last today's copy will be stored
max_file_size — Max file size. Enter the maximum fie size in MiB. Files of a larger size will be excluded from the backup copy
max_dir_size — Max. directory file size. Enter the maximum directory file size in MiB. Directories with files of a larger size will be excluded from the backup copy. The number of files influences the directory file size
autostart — . (Optional parameter. To enable the option click "on".) You can create a cron job to run the backup process automatically. Or you can run the backup manually
run_every — Run. Select the main time frame this cron job will be executed.
full_period — Period. Select period for full backup
full_weekday — Day of week. Select a day of the week to start the backup process
full_monthday — Day of month. Select a day of the month to start the backup process
dlimit — Daily backups . One backup copy for n last days will be stored. n is a specified value
wlimit — Weekly backups . One backup copy for n last weeks will be stored. n is a specified value
mlimit — Monthly backups . One backup copy for n last months will be stored. n is a specified value
Confirm that you want to purge the mailbox
Function: email.clear.request
Access level: 9
The function is simultaneously used to view and change form's data
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the code element of webdomain.error function.
The list object's parameters or additional query parameters (see above):
name — Name. Enter the domain name that uses can use to access the information on the Internet
pooltype — Pool type. Select a pool type that is used by IIS for this site
aliases — Aliases . Enter the name of the alias(es) that you want to add for this WWW-domain, e.g. www.example.com or .example.com, or another name associated with the above domain name. By default the following aliases will be specified: www.example.com and *.example.com
home — Root directory . Enter the path to the WWW-domain's directory that is relative to the owner's home directory
script_selector — Select a script . List of scripts for installation
owner — Owner. Select the WWW-domain's owner
ipaddrs — IP address. List of IP addresses assigned to this WWW-domain
email — Administrator email . Enter an e-mail address that will be shown on error pages of this WWW-domain. By default webmaster@
emailcreate — . (Optional parameter. To enable the option click "on".) Create an administrator's email when creating the WWW-domain
passwd — Administrator's email password . Enter the password to administrator's email
confirm — Re-enter password.
charset — Encoding . Select the encoding that will be used by this WWW-domain.
dirindex — Index page. Enter the filenames that will be seen as index pages for this WWW-domain in descending order of importance, space seperated. For example: index.php index.html index.htm home.html. An index page will be shown when there is no filename specefied in a URL.
secure — . (Optional parameter. To enable the option click "on".) Check the box to activate SSL for this WWW-domain.
hsts — . (Optional parameter. To enable the option click "on".) Select this check box to enable encrypted connection via HTTPS in order to ensure better security
redirect_http — . (Optional parameter. To enable the option click "on".) Check the box to automatically redirect HTTP-requests to HTTPS.
ssl_port — SSL port. Enter the port number that will be used for secure connection through HTTPs.
ssl_cert — SSL certificate . Select an SSL certificate that will be used for this WWW-domain. You can also create a new self-signed certificate.
nginx_proxy — . (Optional parameter. To enable the option click "on".) Use this domain for Nginx-proxy
nginx_proxy_ip — Nginx-proxy IP address. Enter the IP address for proxy
proxy_redirect — . (Optional parameter. To enable the option click "on".) Select the check box to open the control panel when trying to open the domain name. Otherwise, the website will open.
ssi — . (Optional parameter. To enable the option click "on".) Check the box to enable SSI for this WWW-domain.
comment — Comment. Enter detailed description, notes, etc.
ddosshield — . (Optional parameter. To enable the option click "on".) Check the box to enable DDoS protection for this WWW-domain using nginx mod_limit_req.
autosubdomain — Autosubdomains . Set up alias subdomains dynamically based on the directory with subdomain files
php — . (Optional parameter. To enable the option click "on".) Check the box to activate PHP for this WWW-domain. Possible values: on, off.
php_mode — PHP mode. Select the PHP mode for this WWW-domain. Possible values: php_mode_cgi, php_mode_lsapi, php_mode_fcgi_nginxfpm, php_mode_fcgi_apache, php_mode_mod.
basedir — . (Optional parameter. To enable the option click "on".) With the check box selected, the php_admin_value open_basedir parameter will correspond to a home directory, with "none" unselected
php_cgi_version — PHP version (CGI). PHP as CGI. Server administrator can install alternate PHP versions
php_lsapi_version — PHP LSAPI version. Select the PHP version you want to use for this WWW-domain.
php_apache_version — PHP version (Apache module). PHP version, which is used in the "PHP as an Apache module" mode. Only server administrator can set up alternative PHP versions
php_fpm_version — PHP version (PHP-FPM) . PHP version, which is used in the "FastCGI(Nginx + PHP-FPM)" mode. Only server administrator can set up alternative PHP versions. You can change a PHP version for PHP-FPM in the "PHP" module
php_native_version — PHP version . Select the PHP version you want to use for this WWW-domain.
cgi — . (Optional parameter. To enable the option click "on".) Check the box to enable PHP as CGI for this WWW-domain.
cgi_ext — File extensions . Additional file extensions of CGI-scripts
htaccess — . (Optional parameter. To enable the option click "on".)
log_access — . (Optional parameter. To enable the option click "on".) Check the box to activate the access logs for this WWW-domain.
log_error — . (Optional parameter. To enable the option click "on".) Check the box to activate the error log for this WWW-domain.
rotation_period — Rotation period. Select the period for error and access logs rotation
rotation_size — Size. Specify a log size required to start rotation. In practice, the log may have larger size as the rotation process starts once an hour.
rotation_count — Store archives. Enter the number of archives that should be saved upon rotation
analyzer — Analyzer . Select a program to be used for WWW-domain logs analysis.
analyzer_period — Period. Set period to collect statistics. Regardless the period specified, statistics will be collected during rotation
analyzer_lang — Statistics language . Select the language that will be used by the statistics program.
analyzer_secure — . (Optional parameter. To enable the option click "on".) Check the box to protect the acces to the statistics pages of the WWW domain with a password (recommended). If you do not password protect the statistics pages than the statistics pages will be accesible for everyone.
analyzer_passwd — Password . Enter the password that needs to be used to access the statistics pages of this WWW-domain.
analyzer_confirm — Re-enter password. Re-type the password to gain access to statistics
srv_gzip — . (Optional parameter. To enable the option click "on".) Check the box to enable static content compressie (GZIP) for this WWW-domain.
gzip_level — Compression level . Set the content compression level: 1 — minimum, 9 — maximum. Higher values use more system resources. The optimal value is 5.. Values from 1 to 9
expire_times — Cache period . Select the cache period for this WWW-domain.
expire_period — Cache duration. Enter the cache duration (values: 1 — 59 for seconds and minutes, 1 — x for days).
nginx_limitrequest — Requests per second . Enter the number of connections that are allowed from the same IP address per second.
nginx_burstrequest — Maximum peak attack size . Enter the maximum peak attack size.
If the value of "Requests per second" is exceeded, a query queue is created. If the number of requests in the queue exceeds the value of the parameter "Maximum peak attack size", then the connection will be reset with the error 503.
Filter by owner
Function: webdomain.happyfilter
Filter by owner
Access level: reseller+
Web-scripts
Function: aps.user_catalog
Web-scripts
Access level: admin+ user reseller
DDoS-GUARD settings for protection against DDoS
Function: ddosguard.redirect
DDoS-GUARD settings for protection against DDoS
Access level: super+
Delete
Function: webdomain.delete
Delete
Access level: admin+ user reseller
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of webdomain function.
remove_directory — whether to delete the domain directory: on — delete, off — do not delete.
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the path element of webdomain.diraccess function.
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of webdomain.diraccess.user function.
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of webdomain.diraccess.user function.
The list object's parameters or additional query parameters (see above):
name — Username. Enter a username (lower-case letters) to restrict access to the selected directory
passwd — Password. Enter a password to restrict access to the selected directory
confirm — Confirmation . Re-type the password to make sure it is correct
Resume
Function: webdomain.diraccess.user.resume
Resume
Access level: admin+ user reseller
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of webdomain.diraccess.user function.
The list object's parameters or additional query parameters (see above):
specdomain — Domain name. Enter a domain name that will be added to the names of special addresses (gateway, broadcast, subnet). Special addresses are reserved automatically while creating the range
The list object's parameters or additional query parameters (see above):
action_d — Parameter. Select an action that this email filter should perform
folder — Directory . Select a directory where email messages will be located
foldval — New directory name. Enter the name for the new directory where email messages will be located
actval_d — Value. Value of the action that this email filter perfroms
Delete
Function: email.sorter.action.delete
Delete
Access level: 9
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of email.sorter.action function.
The list object's parameters or additional query parameters (see above):
what — Parameter. Parameter that is checked if the condition is met
params — Parameter value . Set the values for condition. You can enter multiple values space separated
not_d — . (Optional parameter. To enable the option click "on".) select the check box if the rule does not match the rule below
mod — Rule. Select a condition that will be used for parameter checks
values — Values. Enter the value that will be compared with the selected parameter. You may provide several parameters line break separated
size_d — Size. Enter the value to check email size (in kb)
Delete
Function: email.sorter.cond.delete
Delete
Access level: 9
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of email.sorter.cond function.
The list object's parameters or additional query parameters (see above):
license_info — License information. Virusdie license information
current_version_info_f — Current versions . Version installed on each cluster node
current_version_info — Current version . Installed version
new_version_info — Available version . The last version available for download
user_chunk — Simultaneous checks . Enter the maximum number of processes that will start during daily user check
priority — Check priority . Set the priority for processes during user check
report_maxsize — Maximum report size . Enter the maximum report size (fiels *.json) that can be processed by Virusdie. Too large report can lead to issues int he control panel (depending on RAM available). If you set 0, the request size won't be checked. You can enter values in bytes, kibibytes (KiB), and mebibytes (MiB)
threads_count — Number of threads . Number of threads during scanning
auto_update — . (Optional parameter. To enable the option click "on".) Select the check box to activate automatic updates for Virusdies
license_renew — . (Optional parameter. To enable the option click "on".) Send a Virusdie license order/renewal request to ISPmanager billing system, and update license information on the server
sendvdemail — . (Optional parameter. To enable the option click "on".) Enable sending of Virusdie scanning reports
send_admin_reports — . (Optional parameter. To enable the option click "on".) Enable sending of periodic reports to the administrator
email — Email. Email address that notifications will be sent to
email_report_period — Report send period . Set the period to send the report to the administrator
scan_archive — . (Optional parameter. To enable the option click "on".) Enable anti-virus scanning. Scanning time will be enlarged
scan_all_files — . (Optional parameter. To enable the option click "on".) Scan files of all types that were not filtered by extensions
Policy
Function: policy
Access level: admin+
The function is simultaneously used to view and change form's data
The list object's parameters or additional query parameters (see above):
enableoversell — . (Optional parameter. To enable the option click "on".) Overselling enables resellers to offer more resources to their users irrespective of the limit that was allocated to these resellers by administrator. However the maximal value of user limit can't exceed the value of a reseller's limit. Please note: all of reseller's users taken together can't consume more resources than provider allocated to the reseller.
For example: provider assigned 1000 WWW domains limit to the reseller. Reseller is able to assign any limit of WWW domains that is not exceeding 1000 to every user he has. However, reseller's users taken together will not be able to create more than 1000 WWW domains.
Some resources can not be overselled, for example: "disk", "trafic", "database volume"
disableuserbackup — . (Optional parameter. To enable the option click "on".) Select the check box to forbid users to make backup copies
nodeassignloadtype — Load balancing on cluster nodes. Select load balancing type that will be applied when creating a new user
autoiprole — Roles for automatically found IP addresses. The selected role will be assigned to IP addresses that will be automatically found on the cluster node interfaces
initialuid — User UID starting with. The control panel will assign UID to newly created users starting with this value. Values from 1500 to 60000
readynodestreshold — Minimum % of ready cluster nodes. The panel will forbid executing distributed queries and user creation queries if the percent of "Ready" cluster nodes in relation to the whole number of servers is less than the value specified. Values from 0 to 100
resourcelevelhigh — High load threshold. Resource usage threshold in %. Once reached, the resource usage will be marked "High". Values from 5 to 94
resourcelevelover — Critical load threshold. Resource usage threshold in %. Once reached, the resource usage will be marked "Critical" . Values from 10 to 99
notifyondiskoverload — . (Optional parameter. To enable the option click "on".) Generate a notification when the cluster node disk usage gets critical
ftpuserprefix — . (Optional parameter. To enable the option click "on".) When the user is creating a new FTP-user, his username will be added to that FTP-user to prevent creation of FTP-users with the same names by different users of the control panel
databaseprefix — . (Optional parameter. To enable the option click "on".) Add a username to the database name to prevent creation of database with the same names by different users of the control panel
databaseuserprefix — . (Optional parameter. To enable the option click "on".) When a user is creating a database user, his username will be added to the database user to prevent creation of database users with the same names by different users of the control panel
insecuredomainpolicy — Different owners for domains and subdomains. You can set the rules to allow creating domain names if subdomain of a higher level have another owner
relocationrsyncnochecksum — . (Optional parameter. To enable the option click "on".) This option disables checks for the strict matching of file contents when moving user files. Checks for the strict matching of file contents is used when changing the user role as the rsync (rsync -c) parameter
http2 — . (Optional parameter. To enable the option click "on".) Enable HTTP/2 for the whole server
apache_select — Apache mode . You can choose another type of Apache. After you make changes, the corresponding software applications will be reinstalled on the cluster nodes, and web-servers will be re-configured
prefork_only — Prefork users . Select users who can use PHP associated only with Apache Prefork
The list object's parameters or additional query parameters (see above):
owner — Owner. Select the owner of users and technical domains
old_techdomain — Current technical domain . Select a technical domain. Select "Don't place on technical domain" to choose users that are not associated with any technical domain
users — Users. Select users you want to move
new_techdomain — New technical domain . Select a technical domain to place users. Select "Don't place on technical domain" if you don't want users to be placed on the technical domain
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the rkey element of techdomain.records function.
The list object's parameters or additional query parameters (see above):
name — Name. Enter the name of the subdomain you want to add or edit. For example, if you want to add a DNS record for the subdomain test.domainname.com, you need to enter only test. You can also use the wild card.
ttl — TTL . Enter the time to live (TTL) value. The TTL value specifies the time a DNS record is stored on a DNS server before it will be refreshed. The default value is 3600.
rtype — Type. Select the DNS recordtype you want to add. After you have added a DNS record, you can not change the DNS record type. If you want to change the DNS record type, you have to create a new DNS record.
ip — IP address. Enter the IP address this DNS record needs to point to.
domain — Domain. Enter the domain name this record needs to point to. Please note: if you enter a domain name you need to add a dot (.) at the end of the domain name.
srvdomain — Domain. Enter the host name of the server this record needs to point to. Please note: if you enter a domain name you need to add a dot (.) at the end of the domain name.
priority — Priority. Enter the priority of this DNS record. If there are several DNS records of the same type, the DNS record with the lowest value will be used first (value 0 — 65535)..
weight — Weight. Enter the weight value of this DNS record. If there are several DNS records of the same type, the DNS record with the lowest value will be used first (value 0 — 65535).
port — Port. Enter the TCP or UDP port number that is assigned to this service.
value — Value. Enter any text
email — Administrator email. DNS administrator email
caa_flags — Flags . 0 — allows, 128 — forbids a Certification Authority to issue certificates, if it doesn't define a tag
caa_tag — Tag . issue — add domain name to allow a Certification authority (CA) to issue certificates
issuewild — add CA domain to allow it issue wildcard certificates
iodef — enter Email or URL of the page for feedback
caa_value_domain — Value. Domain name that will allow or ";" forbid Certification Authorities to issue certificates
caa_value_email — Value. Email or URL of the page for feedback
ds_key_tag — Key tag. Key identifier
ds_algorithm — Algorithm. Encryption key used in DNSSEC key
ds_digest_type — Digest type. Algorithm used to receive digest of key open part
ds_digest — Digest. Digest is provided as a set of hexadecimal symbols with possible spaces between them
The list object's parameters or additional query parameters (see above):
name — Username. Technical domain user
webdomain — WWW-domain. WWW-domain associated with the technical domain
ipaddrs — IP addresses. IP addresses of resource records of the technical domain user
web_ipaddrs — WWW-domain IP addresses . IP addresses of resource records of technical domain users, corresponding to the WWW-domain's IP addresses
Delete user records on the technical domain. To delete users from the technical domain, use the "Move" function
Function: techdomain.users.delete
Delete user records on the technical domain. To delete users from the technical domain, use the "Move" function
Access level: admin+ reseller
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of techdomain.users function.
The list object's parameters or additional query parameters (see above):
name — User. Enter a database username
username — Database username. Enter the name of the database user.
password — Password. Enter the password of the database user.
confirm — Re-enter password. Re-type the password to ensure it is correct
remote_access — . (Optional parameter. To enable the option click "on".) Check the box to give this database user the permission to access databases from a remote location.
addr_list — List of IP addresses. Enter IP addresses or networks that will be allowed to access the database, otherwise access from any host will be allowed.
data_perm1 — . (Optional parameter. To enable the option click "on".) Database access permissions
data_perm2 — . (Optional parameter. To enable the option click "on".)
data_perm3 — . (Optional parameter. To enable the option click "on".)
data_perm4 — . (Optional parameter. To enable the option click "on".)
meta_perm1 — . (Optional parameter. To enable the option click "on".) In this form you can set the database permissions
meta_perm2 — . (Optional parameter. To enable the option click "on".)
meta_perm3 — . (Optional parameter. To enable the option click "on".)
meta_perm4 — . (Optional parameter. To enable the option click "on".)
meta_perm5 — . (Optional parameter. To enable the option click "on".)
meta_perm6 — . (Optional parameter. To enable the option click "on".)
meta_perm7 — . (Optional parameter. To enable the option click "on".)
meta_perm8 — . (Optional parameter. To enable the option click "on".)
meta_perm9 — . (Optional parameter. To enable the option click "on".)
access_perm1 — . (Optional parameter. To enable the option click "on".) Other access permissions
access_perm2 — . (Optional parameter. To enable the option click "on".)
access_perm3 — . (Optional parameter. To enable the option click "on".)
access_perm4 — . (Optional parameter. To enable the option click "on".)
access_perm5 — . (Optional parameter. To enable the option click "on".)
Login to PhpMyAdmin with the permissions of the selected database user.
Function: db.users.redirect
Login to PhpMyAdmin with the permissions of the selected database user.
Access level: admin+ user reseller
Download a dump of the selected database.
Function: db.dump
Download a dump of the selected database.
Access level: admin+ user reseller
Database
Function: db.edit
Access level: admin+ user reseller
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
Parameters:
elid — unique identifier (pair element of db function)
The list object's parameters or additional query parameters (see above):
name — Name. Enter a database username
owner — Owner. Select a control panel user who will be the owner of the database
type — Database server type. Select a database server type
charset — Encoding . Select the default encoding that will be used for this database.
user — User. Select the database user you want to assign to this database.
username — Username. Enter the name for the database user
password — Password. Enter the password for the database user
confirm — Re-enter password. Re-type the password to ensure it is correct
remote_access — . (Optional parameter. To enable the option click "on".) Select the check box to allow this user to access the database from remote servers
addr_list — IP addresses. Enter IP addresses or networks that will be allowed to access the database, otherwise access from any host will be allowed.
comment — Comment. Enter detailed description, notes, etc.
Restore from the local database dump
Function: db.localupload
Access level: admin+ user reseller
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
Parameters:
elid — unique identifier (key element of db function)
The list object's parameters or additional query parameters (see above):
mailto — Email. You can enter an e-mail address using the global setting button of the cronjob module. Afterwards you can receive information by e-mail about a cronjob.
command — Command:. Enter the path to the script that you want to be executed by the cronjob.
description — Description:. This field can be used for additional information about this cron job
active — . (Optional parameter. To enable the option click "on".) Check the box to activate this cron job.
schedule_type — Scheduler. You can configure the settings of a cronjob in basic or in expert mode. The expert mode has more options but you need to have more knowledge about cronjobs to be able to use the expert mode.
run_every — Run. Select the main time frame this cron job will be executed.
time_hour — Time. Enter the hour this cron job will be executed (value 0 -23).
time_min — . Enter the minute this cron job will be executed (value 0 — 59).
wday1 — . (Optional parameter. To enable the option click "on".) Select the check box to start the task every Monday
wday2 — . (Optional parameter. To enable the option click "on".) Select the check box to start the task every Tuesday
wday3 — . (Optional parameter. To enable the option click "on".) Select the check box to start the task every Wednesday
wday4 — . (Optional parameter. To enable the option click "on".) Select the check box to start the task every Thursday
wday5 — . (Optional parameter. To enable the option click "on".) Select the check box to start the task every Friday
wday6 — . (Optional parameter. To enable the option click "on".) Select the check box to start the task every Saturday
wday0 — . (Optional parameter. To enable the option click "on".) Select the check box to start the task every Sunday
month — Month. Select a month to start cron job
month_day — Day of month. Select day of month to run the cron job
input_min — Minutes. Enter the minutes this cronjob needs to be executed. Format: * — for all minutes
input_hour — Hours. Enter the hours this cronjob needs to be executed. Format: * — all hours
input_dmonth — Days of month. Enter the days this cronjob needs to be executed. Format: * — all days of month
input_month — Months. Enter the days this cronjob needs to be executed. Format: * — all months
input_dweek — Days of week. Enter the days of a week this cronjob needs to be executed.Format: * — all days of week
hideout — . (Optional parameter. To enable the option click "on".) Check the box if you do not want to receive the output of this cron job by email.
Suspend
Function: scheduler.suspend
Suspend
Access level: super user
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the key element of scheduler function.
The list object's parameters or additional query parameters (see above):
type — Source upload archive — archive in ISPmanager 6 (Lite, Pro, Host, Business), ISPmanager 5 (Lite, Business), cPanel, Plesk archive URL — archive in ISPmanager 6 (Lite, Pro, Host, Business), ISPmanager 5 (Lite, Bussines), cPanel from local archive in ISPmanager 4 — archive in ISPmanager 4 (Lite, Pro) from ISPmanager 6, ISPmanager 5 — users from ISPmanager 6 (Lite, Pro, Host, Business), ISPmanager 5 (Lite, Business)
local — Path to archive . Path to archive on the server relative to user home directory (normally, it is /var/www/username). For example archive.tar.gz. The system supports backup copies created in ISPmanager 6 (Lite, Pro, Host, Business), ISPmanager 5 (Lite and Business), cPanel, Plesk
url — URL. Enter the URL to a user's backup copy. The system supports backup copies created in ISPmanager 6 (Lite, Pro, Host, Business), ISPmanager5 (Lite, Business), cPanel, Plesk
manager — Control panel URL . Enter the control panel address. ISPmanager will make and download a backup copy of the selected user. The version of the control panel on remote sever must be 5.52.0 or later.
user — Username . Choose a user you want to import. Administrators, resellers, and mailboxes cannot be imported
password — Password. Enter the password to access the server where the server search template was running.
ispmgr4_arc_path — Path to archive . Path to the archive with ISPmanager 4 user backup
restore — . (Optional parameter. To enable the option click "on".) Restore the backup copy after upload. Existing objects won't be removed, but could be modified
The list object's parameters or additional query parameters (see above):
type — Source. upload archive — archive in ISPmanager 6 (Lite, Pro, Host, Business), ISPmanager 5 (Lite, Business), cPanel, Plesk from local archive or directory — archives in ISPmanager 6 (Lite, Pro, Host, Business), ISPmanager 5 (Lite, Bussines), cPanel, Plesk archive URL — archive in ISPmanager 6 (Lite, Pro, Host, Business), ISPmanager 5 (Lite, Bussines), cPanel, Plesk from local archive in ISPmanager 4 — archive in ISPmanager 4 (Lite, Pro) from ISPmanager 4 — users in ISPmanager 4 (Lite, Pro) from ISPmanager 6, ISPmanager 5 — users from ISPmanager 6 (Lite, Pro, Host, Business), ISPmanager 5 (Lite, Business)
node — Cluster node. Select a cluster node that the archive will be imported from
local — Path to archive . Path to archive on the server. If you enter a path to directory, all archives from that directory will be imported. The system supports backup copies created in ISPmanager Lite (Pro, Host), ISPmanager Business and cPanel, Plesk
local_password — Backup copy password. Enter the password to the backup copy. Leaving the field blank if the copy is not encrypted.
url — URL. Enter the URL to a user's backup copy. The system supports backup copies created in ISPmanager 6 (Lite, Pro, Host, Business), ISPmanager5 (Lite, Business), cPanel, Plesk
manager — Control panel URL . Enter the control panel address. ISPmanager will make and download a backup copy of the selected user. The version of the control panel on remote sever must be 5.52.0 or later.
user — Username . Choose a user you want to import. Administrators, resellers, and mailboxes cannot be imported
password — Password. Enter the password to access the server where the server search template was running.
users — Users. Usernames on the remote control panel you want to import
ispmgr4_arc_path — Path to archive . Path to the archive with ISPmanager 4 user backup
ispmgr_manager — Control panel URL . URL of the control panel on the remote server
ispmgr_ssh_port — SSH port . SSH port on remote server
ispmgr_user — Login . Administrator login (usually 'root') on the remote server
auth_type — Authorization on server . You can authorize on remote server under superuser by means of password or SSH-key that is authorized on the remote server and allows for superuser access
ispmgr_password — Password . Administrator password to the remote server
ispmgr_key — Public key . Add this public key to the list of authorized keys on the remote server
restore — . (Optional parameter. To enable the option click "on".) Restore the backup copy after upload. Existing objects won't be removed, but could be modified
The list object's parameters or additional query parameters (see above):
time_zone — Time zone . Time zone
max_execution_time — Execution time . Enter the maximum time a script is allowed to run before the server terminates it
post_max_size — Max. post size. Enter the maximum size of the POST request
upload_max_filesize — Max. file size. Enter the maximum file size for upload
memory_limit — Memory limit . Enter the maximum amount of memory in bytes that a script is allowed to allocate
register_globals — . (Optional parameter. To enable the option click "on".) Check the box to register global variables.
display_errors — . (Optional parameter. To enable the option click "on".) Check the box to enable PHP to send information about errors to the browser. This option can be useful to debug a PHP script.
log_errors — . (Optional parameter. To enable the option click "on".) Check the box to store PHP error messages in the log files. We would recommend that you use this option instead of display_errors after debugging. You can also disable this option to save the disk space.
all_php_errors — . (Optional parameter. To enable the option click "on".) Add E_ALL. Selecting this check box will add a field below where you can select errors that shouldn't be displayed. Otherwise in the same field you can select errors that SHOULD BE DISPLAYED
error_include_flags — Display errors. Select one or several check boxes to show errors
error_exclude_flags — Ignore errors. Select errors that WON'T be displayed
Edit variable
Function: phpconf.edit
Access level: admin+ user
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
Parameters:
plid — parent list unique identifier (key element of phpversions function).
elid — unique identifier (name element of phpconf function)
The list object's parameters or additional query parameters (see above):
apache_value — Variable for Apache . Variable for PHP as an Apache module. Note: the '|#;'~!&()=' symbols cannot be used. If you need to specify a value with these symbols, edit the PHP configuration file using other tools
cgi_value — Variable for CGI . Variable for CGI. Note: the '|#;'~!&()=' symbols cannot be used. If you need to specify a value with these symbols, edit the PHP configuration file using other tools
fpm_value — Variable for FPM . Variable for PHP FPM. Note: the '|#;'~!&()=' symbols cannot be used. If you need to specify a value with these symbols, edit the PHP configuration file using other tools
value — Value.
This parameter won't be available to users
Function: phpconf.suspend
This parameter won't be available to users
Access level: admin+
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of phpconf function.
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of ipaddr.mutualaccess function.
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of ipaddr.mutualaccess function.
Deny access to the server from the selected IP addresses
Function: netactconn.detail.adddenyip
Deny access to the server from the selected IP addresses
Access level: admin+
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the remoteip element of netactconn.detail function.
The list object's parameters or additional query parameters (see above):
type — Cluster node. Cluster node type
name — Name. Enter the name for the cluster node
hostname — Domain name. Domain name (hostname) — this domain name will be specified for the cluster node. You should enter at least a second-level domain (e.g. domain.com)
mainip — IP address. Primary IP address of the cluster node (it is used for SSH connection)
ssh_port — SSH port. Enter the number of the SSH port
admusr — Administrator. Name of the cluster node's administrator
auth_type — Authentication on server. There are two types of remote server authentication: using administrator's password, or based on the SSH key, which allows to access the remote server with superuser permissions
passwd — Administrator password. Enter the administrator password
fmasterkey — Public key. Add the panel's public key the remote server authorised list
comment — Comment. Enter additional information or notes
assign_prio — Priority . Set priority that will be used when creating new users and assigning user roles on the cluster node. The higher the priority, the more users will be located on the cluster node (the cluster node is more likely to be used for new users and new roles of existing users) . Values from 1 to 10000
mainweb — . (Optional parameter. To enable the option click "on".) This server has main role (web-server, ftp, etc.). User files are located on these cluster nodes
main_nameserver — . (Optional parameter. To enable the option click "on".) This server has the primary name server role
nameserver — . (Optional parameter. To enable the option click "on".) This server has the secondary name server role
email_server — . (Optional parameter. To enable the option click "on".) This server has the mail server role, including functions of the mail web-interface
mysql_server — . (Optional parameter. To enable the option click "on".) MySQL server role
remote_access — . (Optional parameter. To enable the option click "on".) Enable remote access to the MySQL database server
ip_select — IP address. Select an IP address that will listen the MySQL server
postgresql_server — . (Optional parameter. To enable the option click "on".) PostgreSQL server role
backup_server — . (Optional parameter. To enable the option click "on".) Backup server
Garbage collection on cluster node
Function: nodegarbage
Access level: admin+
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
Parameters:
elid — unique identifier (name element of node function)
The list object's parameters or additional query parameters (see above):
service_name — Service name. Enter a service name for monitoring
service_process_name — Process name. Name of the process
service_type — Service type. Select a service protocol
custom — . (Optional parameter. To enable the option click "on".) Enter parameters of the IP address and port number
service_select_ip — IP address. IP address where the service is running. If the service listens all server's IP-addresses (0.0.0.0), service availability will be checked on the local IP (127.0.0.1)
service_select_port — Port number. Number of the port where the service is running
service_ip — IP address. IP address where the service is running
service_port — Port number . Number of the port where the service is running
Disable auto-start for this service
Function: services.disable
Disable auto-start for this service
Access level: admin+
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of services function.
The list object's parameters or additional query parameters (see above):
name — Name. Enter a server name that will be used in the control panel
node — Current location. Server
type — Type. Select a database server type
version — Action. Select action (installation/connection) for MySQL-server
host — Server IP address. Enter IP address of the database server
username — Username. Select a user who will be allowed to access the database server
password — Password. Enter a new user password
change_password — . (Optional parameter. To enable the option click "on".) Set a new password for the selected database user who uses admin permissions for access. The new password will be saved only in the control panel, if not otherwise specified.
remote_access — . (Optional parameter. To enable the option click "on".) Enable remote access to the database server
ip_select — IP-address. Select the IP-address which will be listened to by the new MySQL-server
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of db.server.dbunassigned function.
The list object's parameters or additional query parameters (see above):
name — Name. Enter the name of the subdomain you want to add or edit. For example, if you want to add a DNS record for the subdomain test.domainname.com, you need to enter only test. You can also use the wild card.
ttl — TTL . Enter the time to live (TTL) value. The TTL value specifies the time a DNS record is stored on a DNS server before it will be refreshed. The default value is 3600.
rtype — Type. Select the DNS recordtype you want to add. After you have added a DNS record, you can not change the DNS record type. If you want to change the DNS record type, you have to create a new DNS record.
ip — IP address. Enter the IP address this DNS record needs to point to.
domain — Domain. Enter the domain name this record needs to point to. Please note: if you enter a domain name you need to add a dot (.) at the end of the domain name.
srvdomain — Domain. Enter the host name of the server this record needs to point to. Please note: if you enter a domain name you need to add a dot (.) at the end of the domain name.
priority — Priority. Enter the priority of this DNS record. If there are several DNS records of the same type, the DNS record with the lowest value will be used first (value 0 — 65535)..
weight — Weight. Enter the weight value of this DNS record. If there are several DNS records of the same type, the DNS record with the lowest value will be used first (value 0 — 65535).
port — Port. Enter the TCP or UDP port number that is assigned to this service.
value — Value. Enter any text
email — Administrator email. DNS administrator email
caa_flags — Flags . 0 — allows, 128 — forbids a Certification Authority to issue certificates, if it doesn't define a tag
caa_tag — Tag . issue — add domain name to allow a Certification authority (CA) to issue certificates
issuewild — add CA domain to allow it issue wildcard certificates
iodef — enter Email or URL of the page for feedback
caa_value_domain — Value. Domain name that will allow or ";" forbid Certification Authorities to issue certificates
caa_value_email — Value. Email or URL of the page for feedback
ds_key_tag — Key tag. Key identifier
ds_algorithm — Algorithm. Encryption key used in DNSSEC key
ds_digest_type — Digest type. Algorithm used to receive digest of key open part
ds_digest — Digest. Digest is provided as a set of hexadecimal symbols with possible spaces between them
Filter by owner
Function: domain.happyfilter
Filter by owner
Access level: reseller+
Domain name properties
Function: domain.edit
Access level: admin+ user reseller
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
Parameters:
elid — unique identifier (name element of domain function)
The list object's parameters or additional query parameters (see above):
webdomain — . (Optional parameter. To enable the option click "on".) Deleting this domain name will delete the corresponding WWW-domain, if any. This check box is not displayed for reverse zone
maildomain — . (Optional parameter. To enable the option click "on".) Deleting this domain name will also delete the corresponding mail domain, if any. This option is not available for reverse zone
Set filter.
domain.filter
Domain creation settings
Function: dnsparam
Access level: reseller+
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
Parameters:
elid — unique identifier (name element of domain function)
The list object's parameters or additional query parameters (see above):
ns — Name servers. Enter the name servers that will manage newly created domain names
email — Administrator email . Enter the DNS administrator email. It is specified in the SOA record of a newly created domain zone
default_dmarc — DMARC record . Default DMARC record
default_spf — SPF record . Default SPF record. Please note: the macro'ip' will be changed into automatic IP addresses
fixalld — . (Optional parameter. To enable the option click "on".) Select the check box to apply the changes of name servers, administrator email, SPF and DMARC to all existing domain names . Otherwise, changes will be applied only to newly created domain names
subdom — Subdomains. Enter subdomains that will be created automatically when adding a new domain
mx — Mail servers. Enter the name(s) of the mail servers that will handle the e-mail for this domain.
nsips — IP addresses for name servers. If the NS-record lies within the domain zone being created, A and AAA records will be created automatically for that domain zone. If this parameter is specified, IP addresses for the NS-record will be taken from this parameter. Otherwise, IP address of the master zone will be assigned to the first NS-record, IP address of the slave zone will be assigned to all other records (if slave name servers are used). If slave name servers are not configured, or the NsIps parameter has insufficient IP addresses, you will see the error message: "An error occurred while working with DNS. Insufficient number of ip-addresses for name servers. Required number: 'X'"
dnshostname — Server name for SOA-records. Leave the field blank if you are not sure whether you need these settings or not. This parameter will help specify a value for the SOA-record, if you want the server name defined in the SOA-record (MNAME) to be different from the hostname processing DNS requests.
usednssec — . (Optional parameter. To enable the option click "on".) Enable DNSSEC
ksk_algorithm — Algorithm. Algorithm used to generate a key
ksk_key_size — Key length. Number of bits in the key
ksk_rsasha512_size — Key length. Number of bits in the key
ksk_period — Renewal period. Key restoration period
zsk_algorithm — Algorithm. Algorithm used to generate a key
zsk_key_size — Key length. Number of bits in the key
zsk_rsasha512_size — Key length. Number of bits in the key
The list object's parameters or additional query parameters (see above):
domain_select — Domain . Brand settings will be modified for the selected domain name
manager — . Select a control panel which interface view you want to change
domain_all — . (Optional parameter. To enable the option click "on".) The control panel view may differ depending on the domain name that you used
domain — Domain name. Enter the domain name. Interface settings will be applied only when accessing the panel via this name
h — Hue. Hue of the color scheme . Values from -180 to 180
s — Saturation. Color scheme saturation . Values from -100 to 100
l — Brightness. Color intensity . Values from -100 to 100
header — Window heading. This field will be used as the page heading
site — Logo URL. Enter the site address that will open when clicking the logo
signature — Copyright notice. Copyright notice. Normally it is specified as: the copyright sign, copyright holder and company working years
homepage — Home page. Enter the URL of the company's home page. You can use the $lang macro, which will be changed into a language code
contacts — Contacts. You can add a link to your company's contacts. The link will be shown in the Login form. You can use the $lang macro, which will be changed into a language code
head — Heading. This code will be added into the page heading (HEAD)
body — Body. This code will be added at the end of the page body (BODY)
User settings
Function: usrparam
Access level: 9 user reseller
The function is simultaneously used to view and change form's data
The list object's parameters or additional query parameters (see above):
enotify_free_space — . (Optional parameter. To enable the option click "on".) Enable free disk space notifications. Low disk and mailbox size notifications will be sent to the specified email address
Web-disk configuration
Function: webdisk.user
Access level: user
The function is simultaneously used to view and change form's data
The list object's parameters or additional query parameters (see above):
enabled — . (Optional parameter. To enable the option click "on".) With this option you can enable or disable the backup module globally. If you want to enable or disable the backup creation for a specific user, please use the user configuration form.
storage_type — Storage type . Please note: If you change the storage type, the existing backup files will become inaccessible. You can access those backup files again by re-selecting the previous storage type.
arch_password — Backup copy password . Enter a password for archive encryption. Leaving the field blank will not encrypt the data
path_local — Path to directory . Enter the path to the directory where the backups will be stored
code_dropbox — Access code . Follow the link below to get the access code. After you logged in to Dropbox, the "Access code" will be applied automatically
path_dropbox — Path to backup directory . Directory to store backups
code_googledrive — Access code. Follow the link below to get an access code. After you log in to Google Drive, the "Access code" field will be filled out automatically
path_googledrive — Path to backups . Enter the directory where backups will be saved
code_yandex — Access code . Follow the link below to get the access code. After you logged in to Yandex.Disk, the "Access code" will be applied automatically
path_yandex — Path to backup directory. Directory to store backups
id_amazon — Access code . Follow the link above to obtain an Amazon S3 access code
secret_amazon — Password . Follow the link below (the Amazon console) to get Amazon.S3 login/password. Create a user in the Amazon console and grant him permissions to access the storage. AWS_ID and AWS_SECRET into the "Access code" and "Passwords" fields.
bucket_amazon — Bucket . Storage name in Amazon S3
bucket_name — Bucket name . The bucket name you choose must be unique across all existing bucket names in Amazon S3 Storage
url — Server URL . Enter a URL to the FTP server to store backups. FTP protocol is used
port_ftp — Port FTP . Enter the number of FTP-server port
path_ftp — Path to backup directory. Directory to store backups
username — User. Username
password — Password. Enter the password to access the server where the server search template was running.
url_sftp — Server URL . Enter the SFTP server address to store backups. The SSH FTP protocol is used. You can enter IPv4 and IPv6 addresses
port_ssh — SSH port . Enter an SSH port
path_sftp — Path to backup directory. Directory to save backups
auth_type — Authentication on server. There are two types of remote server authentication: using administrator's password, or based on the SSH key, which allows to access the remote server with superuser permissions
admname — Username . Username
passwd — .
fmasterkey — Private key . Private key for access to the remote server
nodes — Backup servers . Select the cluster nodes that will be used to store the backup files. You can select them in the list of cluster nodes as well.
size_limit — Total size. You can limit the total volume of backups for this server. For local storages this limitation is applied to every cluster node individually. Once exceeded, the oldest backups will be deleted. If you leave this field blank backups will be kept as long as the storage has enough space. Total number of backups can be limited in the configuration file with the BackupCountLimit parameter, the default value is 14 (7 daily and 7 weekly backups). Total size is set in bytes, however, units of measure can be specified, e.g. 100Mib. If backup process is not set up, selecting a local storage, will ask for 50% from the available disk space
full_count — Full backup copies. Amount of full backup copies
exclude_files — Exclude files . Choose files you want to exclude from the backup copy (every exclusion should be placed on a new line). Enter paths relative to user home directory (normally, it is /var/www/username). E.g.: data/.filemgr-tmp. You can use ***, to change symbols in the file name
exclude_db — Exclude databases . You can list databases (every database should be placed on a new line) that will be excluded from backups
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the kname element of backup2.superlist.users function.
plid — parent list unique identifier (keydate element of backup2.superlist function — date in the YYYY-MM-DD format. For example, 2020-09-21).
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the kname element of backup2.superlist.users function.
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the kname element of backup2.superlist.roots function.
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the kname element of backup2.superlist.roots function.
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the keydate element of backup2.superlist function.
The list object's parameters or additional query parameters (see above):
name — Name. Enter the name for the mailbox
domainname — Domain. Mail domain associated with this mailbox
aliases — Aliases . Enter aliases for this mailbox
passwd — Password. Enter a password to access the mailbox
confirm — Re-enter password.
forward — Send a copy to. Forward email copies to this address
dontsave — . (Optional parameter. To enable the option click "on".) Select the check box if you do not want to save received e-mail messages in this mailbox
maxsize — Disk space. Enter the maximum size of the mailbox in MiB
greylist — . (Optional parameter. To enable the option click "on".) Greylisting is a method of defending e-mail users against spam that emporarily rejects any email from a sender it does not recognize.
spamassassin — . (Optional parameter. To enable the option click "on".) SpamAssassin uses a variety of spam-detection techniques, that includes DNS-based and fuzzy-checksum-based spam detection, Bayesian filtering, external programs, blacklists and online databases.
note — Notes. Additional information, notes, etc.
Clear the contents of the mailbox
Function: email.clear
Clear the contents of the mailbox
Access level: admin+ user reseller
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of email function.
The list object's parameters or additional query parameters (see above):
account_f — Account. Use "Account" as a parameter value during manual configuration of the email client
server_in_f — Incoming mail server name. Use "Incoming mail server" as a parameter value during manual configuration of the email client
pop_port_f — POP3 port. Use "POP3 port" as a parameter value during manual configuration of the email client
pop_ssl_port_f — POP3 SSL/TLS port. Use "POP3 port" as a parameter value during manual configuration of the email client, if encryption is used for POP3
imap_port_f — IMAP port. Use "IMAP port" as a parameter value during manual configuration of the email client
imap_ssl_port_f — IMAP SSL/TLS port. Use "IMAP port" as a parameter value during manual configuration of the email client, if encryption is used for IMAP
server_out_f — Outgoing mail server name. Use "Outgoing mail server" as a parameter value during manual configuration of the email client
smtp_port_f — SMTP port. Use "SMTP port" as a parameter value during manual configuration of the email client
smtp_tls_port_f — SMTP SSL/TLS port. Use "SMTP port" as a parameter value during manual configuration of the email client, if encryption is used for SMTP
Delete
Function: email.delete
Delete
Access level: admin+ user reseller
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of email function.
The list object's parameters or additional query parameters (see above):
name — Name. Enter a domain name
owner — Owner. Select a domain owner
ipsrc — IP address. Select an IP address to send emails through the SMTP protocol
defaction — Default action. Select a default action that will be performed if the mailbox for this domain name does not exist
redirval — Redirect to. Enter a domain or mailbox to which emails from non-existent mailboxes will be redirected
greylist — . (Optional parameter. To enable the option click "on".) Greylisting is a method of defending e-mail users against spam that emporarily rejects any email from a sender it does not recognize.
spamassassin — . (Optional parameter. To enable the option click "on".) SpamAssassin uses a variety of spam-detection techniques, that includes DNS-based and fuzzy-checksum-based spam detection, Bayesian filtering, external programs, blacklists and online databases.
avcheck — . (Optional parameter. To enable the option click "on".) ClamAV is an open source antivirus engine for checking files attached to email messages
dkim — . (Optional parameter. To enable the option click "on".) DomainKeys Identified Mail (DKIM) is an email validation system designed to detect email spoofing by providing a mechanism to allow receiving mail exchangers to check that incoming mail from a domain is authorized by that domain's administrators.
dkim_selector — DKIM-selector . Enter a DKIM value
dkim_keylen — DKIM key length . Enter the length of the DKIM key
dmarc — . (Optional parameter. To enable the option click "on".) Domain-based Message Authentication, Reporting and Conformance or DMARC is a technical specification designed for reducing the amount of spam and fishing mail
comment — Comment. Enter detailed description, notes, etc.
secure — . (Optional parameter. To enable the option click "on".) Do you want to use secure connection with email domain via SSL/TLS
secure_alias — Alias for certificate. Enter an alias (it can be domain name as well) the certificate will be installed to
ssl_name — SSL-certificate . Enter an SSL-certificate that will be used for this mail domain. You can enter an existing certificate from the list, or create a new self-signed certificate
email — Email. Enter an email address of the contact person
Filter by owner
Function: emaildomain.happyfilter
Filter by owner
Access level: reseller+
Set filter.
emaildomain.filter
OneClickSSL
Function: oneclickssl.settings
Access level: admin+
The function is simultaneously used to view and change form's data
Default settings. Access permissions set for the selected user/group including permissions on columns and rows (if it is a list or form) will be deleted
Function: userrights.delete
Default settings. Access permissions set for the selected user/group including permissions on columns and rows (if it is a list or form) will be deleted
Access level: admin+
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of userrights function.
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of userrights.fields function.
Default settings. Access permissions set for the selected user/group including permissions on columns and rows (if it is a list or form) will be deleted
Function: userrights.fields.delete
Default settings. Access permissions set for the selected user/group including permissions on columns and rows (if it is a list or form) will be deleted
Access level: admin+
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of userrights.fields function.
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of userrights.fields function.
The list object's parameters or additional query parameters (see above):
inhereted — . (Optional parameter. To enable the option click "on".) Do not set field permissions. They will be taken from groups to which this user is assigned
read — . (Optional parameter. To enable the option click "on".) Allow reading the field
write — . (Optional parameter. To enable the option click "on".) Allow editing the field
new — . (Optional parameter. To enable the option click "on".) Allow editing the form while creating an object
Access to functions
Function: userrights.edit
Access level: admin+
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
Parameters:
plid — parent list unique identifier (name element of admin function).
elid — unique identifier (name element of userrights function)
The list object's parameters or additional query parameters (see above):
policy — Default policy settings. Set the user access permissions to the functions. Changing this value will reset the current access permissions. If the user is assigned into any group, the group settings will have higher priority
Resume
Function: userrights.resume
Resume
Access level: admin+
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of userrights function.
The list object's parameters or additional query parameters (see above):
behavior — Behavior. Select how you want to restore data from the backup.
Skip data – do not restore data and dependent elements that already exist in the system. Edit existing data – restore all the data from the archive.
E.g. you have a web-domain, which files were deleted from its home directory. If you choose “Skip existing data” while restoring the domain, its files won’t be restored. If you choose “Edit existing data”, domain’s files and settings will be restored.
The list object's parameters or additional query parameters (see above):
type — Upload type. Select the upload type you want to use. You can upload files from your local computer or from a remote server. The files will be stored into the current folder.
The list object's parameters or additional query parameters (see above):
password — Password. The password that was used during the backup process
Restore the selected file or folder.
Function: backup2.list.files.restore
Restore the selected file or folder.
Access level: user
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the kname element of backup2.list.files function.
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the elname element of backup2.list.db function.
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the kname element of backup2.list.email function.
The list object's parameters or additional query parameters (see above):
username — Username. CSR will be generated for this user
domain — Domain name. Enter the domain names this SSL certificate will be issued for (the first domain will be used as Common name, other domains — as alternative names)
name — CSR name . Enter the name of the CSR that will be generated. This name will be used by the control panel after the CSR is generated.
code — Country code. Enter a two-letter country code
state — Region. Enter your state, province or region
city — City. Enter a city where the organization is registered
org — Organization . Enter your organization name
department — Organization unit . Enter the organization unit that will purchase this SSL certificate
email — Email. Enter an email address of the contact person
keylen — Key length . Enter the certificate key length to ensure best cryptography security
Filter by owner
Function: sslcert.csr.happyfilter
Filter by owner
Access level: reseller+
Set filter.
sslcert.csr.filter
Approve CSR
Function: sslcert.csr.approve
Access level: admin+ user reseller
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
Parameters:
plid — parent list unique identifier (key element of sslcert function).
elid — unique identifier (name element of sslcert.csr function)
The list object's parameters or additional query parameters (see above):
enable_cert — . (Optional parameter. To enable the option click "on".) Check the box to enable the SSL certificate after it is generated.
wildcard — . (Optional parameter. To enable the option click "on".) Issue the Wildcard SSL-certificate. Domain verification will be performed via DNS.
dns_check — . (Optional parameter. To enable the option click "on".) Select the check box to enable DNS-based validation
domain_name — Domain. Select the domain you want to genereate an SSL certificate for. For example, "domain.com".
crtname — SSL-certificate name . Enter the name of the SSL certificate that will be generated. This name will be used for the SSL certificate in the control panel after it is generated.
username — Username. CSR will be generated for this user
domain — Domain names of the certificate and its aliases. For example, "domain.com www.domain.com".
name — CSR name . Enter the name of the CSR that will be generated. This name will be used by the control panel after the CSR is generated.
code — .
state — State — province.
city — .
org — .
department — .
email — . Enter email address
keylen — .
Change the SSL certificate
Function: sslcert.replace
Access level: admin+ user reseller
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
Parameters:
elid — unique identifier (key element of sslcert function)
The list object's parameters or additional query parameters (see above):
name — Domain name. Users cannot use this domain name to create their domains
Delete
Function: domain.blacklist.delete
Delete
Access level: admin+
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of domain.blacklist function.
The list object's parameters or additional query parameters (see above):
name — Name. Enter the storage name. The name will be shown in the interface
search_backups — . (Optional parameter. To enable the option click "on".) Search for backup copies in the storage and import the lst files into the panel. The search is performed based on readme-files
userlevel — . (Optional parameter. To enable the option click "on".) Allow users to use this storage to do their backups
missed_archives_list — List of missing archives:. List of missing archives in the new storage. You cannot restore data from archives in the this list
missed_archives_agree — . (Optional parameter. To enable the option click "on".)
Set filter.
backup.storages.filter
Add
Function: backup.storages.add
Add
Access level: admin+ user
Delete
Function: backup.storages.delete
Delete
Access level: admin+ user
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of backup.storages function.
The list object's parameters or additional query parameters (see above):
enable — . (Optional parameter. To enable the option click "on".)
maxbodysize — Maximum post size. Enter the maximum request size (in bytes, KiB, and MiB) that the Nginx proxy module can handle (client_max_body_size). 0 means that a request size won't be checked.
The list object's parameters or additional query parameters (see above):
autorun — . (Optional parameter. To enable the option click "on".) This means that anti-virus check will be started automatically by cron
enabled — . (Optional parameter. To enable the option click "on".) Allow a user to start anti-virus scanning with Virusdie, view reports, and disinfect files. If this option is not enabled, reports will be available only for admin
maxreports — Save reports . The number of user archives will increase with every new anti-virus check. This parameters sets the maximum number of archives to store. The oldest archives will be deleted when processing a new one
max_age — Take date of change into account. Scan only files which have been changed after the specified date
max_time — Take time of change into account. Scan only files which have been changed after the specified time, with regard to date
max_size — Take file size into account. Scan only files not exceeding the specified size
autocure — . (Optional parameter. To enable the option click "on".) Enable automatic disinfection (disinfect found threats)
autodelete — . (Optional parameter. To enable the option click "on".) Allow to delete file, if disinfection requires file deletion
sendvdemail — . (Optional parameter. To enable the option click "on".) Send scanning reports to the user email
email — Email. Email address that notifications will be sent to
The list object's parameters or additional query parameters (see above):
is_directory — . (Optional parameter. To enable the option click "on".) Exclude a directory
filename — File/directory name. Name of the file/directory excluded from the anti-virus scanning
Delete
Function: virusdie.userexcludes.delete
Delete
Access level: user
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of virusdie.userexcludes function.
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of virusdie.userreports function.
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of virusdie.userreports.threatlist function.
The list object's parameters or additional query parameters (see above):
filename — File name. Name of the file with infected code
content — Infected section . Infected section of the code
Restore the file from the report archive
Function: virusdie.userreports.threatlist.restore
Restore the file from the report archive
Access level: user
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of virusdie.userreports.threatlist function.
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of virusdie.userreports.threatlist function.
The list object's parameters or additional query parameters (see above):
security_level — Security level . Select a security profile
challenge_ttl — Access time (sec.) . Period when user will be able to access the resource after check (for example, Capcha)
minify — Minify . Reduce file size by deleting unnecessary symbols in html, js, css files
ssl — SSL. Enable SSL. Learn more in Documentation
auto_records — . (Optional parameter. To enable the option click "on".) Automatically upload changes of DNS-records to Cloudflare
always_online — . (Optional parameter. To enable the option click "on".) If the site is not accessible, it will run from CDN
mobile_redirect — . (Optional parameter. To enable the option click "on".) Activate redirects to the selected page if a user accesses the site from mobile device
mobile_subdomain — Alias for redirect . Enter the domain name without domain zone. It must be connected to Cloudflare
strip_uri — . (Optional parameter. To enable the option click "on".) Always redirect to website's Homepage
development_mode — . (Optional parameter. To enable the option click "on".) Activate developer mode. It will be disabled automatically in 3 hours
email_obfuscation — . (Optional parameter. To enable the option click "on".) Allows to hide mailboxes from bots, while keeping them visible to humans.
hotlink_protection — . (Optional parameter. To enable the option click "on".) Forbid other sites to download images hosted on your site
automatic_https_rewrites — . (Optional parameter. To enable the option click "on".) Automatic HTTPS rewrites
security_header — . (Optional parameter. To enable the option click "on".) Defines the time to connect to web-site only via HTTPS
max_age — Time (sec.) . Operation time in seconds
include_subdomains — . (Optional parameter. To enable the option click "on".) Enable subdomains
nosniff — . (Optional parameter. To enable the option click "on".) Reduce MIME type security risks
tls_1_3 — . (Optional parameter. To enable the option click "on".) Enable the lasted version of TLS 1.3 protocol
server_side_exclude — . (Optional parameter. To enable the option click "on".) Allows to hide content of html-pages from "suspicious" visitors
ipv6 — . (Optional parameter. To enable the option click "on".) Enable IPv6 support
User data
Function: cloudflare.userdata
Access level: user
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
Parameters:
elid — unique identifier (name element of cloudflare function)
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the rkey element of cloudflare.records function.
The list object's parameters or additional query parameters (see above):
rtype — Type. Select the DNS recordtype you want to add. After you have added a DNS record, you can not change the DNS record type. If you want to change the DNS record type, you have to create a new DNS record.
name — Name. Enter the name of the subdomain you want to add or edit. For example, if you want to add a DNS record for the subdomain test.domainname.com, you need to enter only test. You can also use the wild card.
service — Service . Service
proto — Protocol. Protocol
ttl — TTL . Enter the time to live (TTL) value. The TTL value specifies the time a DNS record is stored on a DNS server before it will be refreshed. The default value is 3600.
ip — IP address. Enter the IP address this DNS record needs to point to.
domain — Domain. Enter the domain name this record needs to point to. Please note: if you enter a domain name you need to add a dot (.) at the end of the domain name.
srvdomain — Domain. Enter the host name of the server this record needs to point to. Please note: if you enter a domain name you need to add a dot (.) at the end of the domain name.
priority — Priority. Enter the priority of this DNS record. If there are several DNS records of the same type, the DNS record with the lowest value will be used first (value 0 — 65535)..
weight — Weight. Enter the weight value of this DNS record. If there are several DNS records of the same type, the DNS record with the lowest value will be used first (value 0 — 65535).
port — Port. Enter the TCP or UDP port number that is assigned to this service.
value — Value. Enter any text
proxied — . (Optional parameter. To enable the option click "on".) Enable record proxy (CDN)
OS installation
Function: cloudflare.add_domain
Access level: user
The function is simultaneously used to view object's parameters, to change an object, and create new one.
View object's parameters:
Parameters:
elid — unique identifier (name element of cloudflare function)
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the rule_id element of cloudflare.firewall function.
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the url element of cloudflare.pages function.
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the url element of cloudflare.pages function.
browser_check — . (Optional parameter. To enable the option click "on".) Browser integrity check
cache_level — Cache level . Cache level
disable — Disable functions . Disable functions
email_obfuscation — . (Optional parameter. To enable the option click "on".) Allows to hide mailboxes from bots, while keeping them visible to humans.
security_level — Security level . Security level
server_side_exclude — . (Optional parameter. To enable the option click "on".) Allows to hide content of html-pages from "suspicious" visitors
ssl — SSL. SSL
Delete the selected rule for the page
Function: cloudflare.pages.delete
Delete the selected rule for the page
Access level: user
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the url element of cloudflare.pages function.
The list object's parameters or additional query parameters (see above):
keep_old — Keep old notifications (days). Information about notifications that did not occur during a selected period, will be deleted automatically. The default value is 30 days
keep_solved — Keep resolved issues (days). Information about issues that were resolved this number of days ago, will be deleted automatically. The default value is one week
show_userproblems — . (Optional parameter. To enable the option click "on".) Select the check box to display users' notifications. The check box is not selected by default
notification_enabled — . (Optional parameter. To enable the option click "on".) Select the check box to send error notifications
smtpserver — SMTP-server . Enter the SMTP server for sending notifications
smtpport — SMTP-server port. Enter an SMTP port for sending notifications
address_to — Email for notifications . Enter an email address to which new notifications will be sent
address_from — Sent from . Enter an email address from which new notifications will be sent
plang — Notification message language. Select a language that will be used in notifications
Resolve the selected error message automatically.
Function: problems.solve
Resolve the selected error message automatically.
Access level: user reseller
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of problems function.
autosolve — . (Optional parameter. To enable the option click "on".) Select the check box to try to resolve the problem automatically at specified period
autosolve_period — Period (min). Period in minutes that will pass before a new attempt to resolve the issue will be made
solvenow — . (Optional parameter. To enable the option click "on".) With this option selected, clicking OK will try to resolve this issue
params — Additional information. Additional information related to this problem
Delete the selected error message.
Function: problems.delete
Delete the selected error message.
Access level: user reseller
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of problems function.
The list object's parameters or additional query parameters (see above):
name — Name. Enter the name for the template. You can choose this template when creating new accounts
level — Type. Select an account type that can be created based on this template
apply — . (Optional parameter. To enable the option click "on".) Apply the changes to all users based on this template
apply_cl_php — . (Optional parameter. To enable the option click "on".) Install the selected PHP version for all users created based on this template
comment — Comment. Enter detailed description, notes, etc.
backup — . (Optional parameter. To enable the option click "on".) Select the check box to make sure backups on regular basis
limit_virusdie_autorun — . (Optional parameter. To enable the option click "on".) Automatically run a cron job for anti-virus scanning for user
limit_virusdie — . (Optional parameter. To enable the option click "on".) Allow a user to run anti-virus scanning with Virusdie, view check reports, and disinfect files. If this check box is not selected, reports and operations will be available only to admin
limit_ssl — . (Optional parameter. To enable the option click "on".) Select the check box to enable HTTPS for the WWW-domains of this user
limit_cgi — . (Optional parameter. To enable the option click "on".) Select the check box to activate CGI for WWW-domains of this user
limit_php_mode_mod — . (Optional parameter. To enable the option click "on".) Select the check box to activate PHP scripts for the WWW-domains of this user. The scripts will be executed with web-server's privileges. It is not secure because such scripts can access the information in the directory of other users.
limit_php_mode_lsapi — . (Optional parameter. To enable the option click "on".) The user will be able to create WWW-domains supporting PHP scripts. The scripts will be executed with user permissions and "LiteSpeed Technologies API for PHP" for Apache
limit_php_mode_cgi — . (Optional parameter. To enable the option click "on".) Select the check box to run PHP scripts for WWW-domains of this user. The scripts will be executed with privileges of the WWW-domain's owner (in the same way as CGI scripts)
limit_php_mode_fcgi_apache — . (Optional parameter. To enable the option click "on".) Select the check box to activate PHP scripts for the WWW-domains of this user. The scripts will be executed with user privileges using FastCGI (requests are processed by Apache) allowing for better performance. Update the web-server after the PHP parameters are modified
limit_php_mode_fcgi_nginxfpm — . (Optional parameter. To enable the option click "on".) Select the check box to activate PHP scripts for the WWW-domains of this user. The scripts will be executed with user privileges using FastCGI (Nginx will resend requests to the PHP-FPM processes manager ) allowing for better performance. Update the web-server after the PHP parameters are modified
limit_php_fpm_version — PHP version (PHP-FPM). Select the PHP version that will be used for scripts running as PHP-FPM
limit_shell — . (Optional parameter. To enable the option click "on".) Allow shell access to this server
limit_users — Users. The maximum number of user that this reseller can create
limit_resellertechdomain — Technical domains . Set the maximum number of technical domains that the reseller can create
limit_ipv4addrs — IPv4 addresses. Enter the maximum number of IPv4 addresses that can be allocated to a reseller
limit_ipv6addrs — IPv6 addresses. Enter the maximum number of IPv6 addresses that can be allocated to a reseller
limit_quota — Disk (MiB). Enter the maximum disk space in MB that can be used by files of this user
limit_traff — Traffic. Set a limit on the maximum amount of traffic allocated to WWW-domains and FTP-users per calendar month (from the first to the last date of the month)
limit_db — Databases. Enter the maximum number of databases that can be used by this user
limit_dbsize — Database size . Enter the maximum disk space size that can be allocated to the user's databases
limit_db_users — Database users. Enter the maximum number of database users that can this user can create
limit_ftp_users — FTP users. Enter the maximum number of FTP accounts that this user can create
limit_webdomains — WWW-domains. Enter the maximum number of WWW-domains that this user can create
limit_domains — Domain names. Enter the maximum number of of domain names (DNS) that this user can manage
limit_emaildomains — Mail domains. Enter the maximum number of mail domains that can be used by this user
limit_emails — Mailboxes . Enter the maximum number of mailboxes that can be used by this user
limit_cpu — CPU time. Sets a limit on CPU usage by user processes
limit_memory — RAM. Set a limit on the maximum amount of RAM allocated to this user
limit_process — User processes. Set a limit on the maximum number of processes allocated to this user
limit_email_quota — Mailbox maximum size. Enter the maximum size for the user's mailbox
limit_mailrate — Email limit . You can set the limit on the number of emails that can be sent from each mailbox per hour
limit_scheduler — Cron jobs. Enter the maximum number of cron jobs that can be created
limit_nginxlimitconn — Simultaneous connections per session. Set limit on the maximum number of simultaneous connections from a specific IP address that will be processed by the web-server
limit_maxclientsvhost — Apache handlers. Limits the maximum number of Apache handlers that process the user's WWW-domain
limit_mysql_maxuserconn — Simultaneous MySQL-connections. Set a limit on the maximum number of new simultaneous connections any individual user may have to the MySQL database per hour
limit_mysql_maxconn — MySQL-connections. Set a limit on the maximum number of connections any individual user may have to the MySQL database per hour
limit_mysql_query — MySQL queries. Set a limit on the maximum number of commands any individual MySQL-user may execute per hour
limit_mysql_update — MySQL update-query. Set a limit on the maximum number of commands modifying the data any individual MySQL-user may execute per hour
limit_cl_cpu — CPU load limit. Percentage of CPU utilization that occurred while executing at the user level.
limit_cl_nproc — Total number of processes. Enter the total number of processes allocated to each user
limit_cl_pmem — Physical memory. Enter the maximum amount of physical memory allocated to this user. Shared memory and disk cache used by user processes are also counted
limit_cl_io — I/O limit. I/O limit
limit_cl_maxentryprocs — LVE concurrent connections . Enter the maximum number of entries into LVE. We don't count processes that are already created
limit_cl_cagefs — . (Optional parameter. To enable the option click "on".) Enable CageFS for this user
limit_cl_php — PHP version. PHP version available to users
limit_charset — Domain encoding. Set default encoding
limit_php_mode — PHP mode. Default PHP mode
limit_php_cgi_version — Default PHP version (CGI) . Default PHP version that is used for scripts in CGI mode
limit_php_lsapi_version — Default PHP version for LSAPI. Select the PHP version that will be used for scripts running in the PHP as LSAPI mode
limit_dirindex — Index page. Default index page
limit_techdomain — Technical domains . Technical domain where the user is located
Allow to create users with this template on the cluster node
Function: preset.allocation.resume
Allow to create users with this template on the cluster node
Access level: admin+ reseller
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of preset.allocation function.
Deny to create users with this template on the cluster node
Function: preset.allocation.suspend
Deny to create users with this template on the cluster node
Access level: admin+ reseller
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of preset.allocation function.
The list object's parameters or additional query parameters (see above):
name — Login . Enter a username to login the control panel and enable shell acess (if permitted)
fullname — Full name. Enter a full name of the user, it can be his first and last names, or any other information related to this account
owner — Owner. Owner of the newly created user
preset — Template. You can select a template not to specify the limits manually. Values from the template will be set automatically. Editing the template will enable you to change properties for all the users based on this template
passwd — . Enter a new user password. Leaving this field blank will not change the password
confirm — Re-enter password. Re-enter the password to ensure it is correct.
create_time — Creation date . User creation form
comment — Comment. Enter detailed description, notes, etc.
backup — . (Optional parameter. To enable the option click "on".) Select the check box to make sure backups on regular basis
limit_virusdie_autorun — . (Optional parameter. To enable the option click "on".) Automatically run a cron job for anti-virus scanning for user
limit_virusdie — . (Optional parameter. To enable the option click "on".) Allow a user to run anti-virus scanning with Virusdie, view check reports, and disinfect files. If this check box is not selected, reports and operations will be available only to admin
limit_ssl — . (Optional parameter. To enable the option click "on".) Select the check box to enable HTTPS for the WWW-domains of this user
limit_cgi — . (Optional parameter. To enable the option click "on".) Select the check box to activate CGI for WWW-domains of this user
limit_php_mode_mod — . (Optional parameter. To enable the option click "on".) Select the check box to activate PHP scripts for the WWW-domains of this user. The scripts will be executed with web-server's privileges. It is not secure because such scripts can access the information in the directory of other users.
limit_php_mode_lsapi — . (Optional parameter. To enable the option click "on".) The user will be able to create WWW-domains supporting PHP scripts. The scripts will be executed with user permissions and "LiteSpeed Technologies API for PHP" for Apache
limit_php_mode_cgi — . (Optional parameter. To enable the option click "on".) Select the check box to run PHP scripts for WWW-domains of this user. The scripts will be executed with privileges of the WWW-domain's owner (in the same way as CGI scripts)
limit_php_mode_fcgi_apache — . (Optional parameter. To enable the option click "on".) Select the check box to activate PHP scripts for the WWW-domains of this user. The scripts will be executed with user privileges using FastCGI (requests are processed by Apache) allowing for better performance. Update the web-server after the PHP parameters are modified
limit_php_mode_fcgi_nginxfpm — . (Optional parameter. To enable the option click "on".) Select the check box to activate PHP scripts for the WWW-domains of this user. The scripts will be executed with user privileges using FastCGI (Nginx will resend requests to the PHP-FPM processes manager ) allowing for better performance. Update the web-server after the PHP parameters are modified
limit_php_fpm_version — PHP version (PHP-FPM). Select the PHP version that will be used for scripts running as PHP-FPM
limit_shell — . (Optional parameter. To enable the option click "on".) Allow shell access to this server
limit_users — Users. The maximum number of user that this reseller can create
limit_resellertechdomain — Technical domains . Set the maximum number of technical domains that the reseller can create
limit_ipv4addrs — IPv4 addresses. Enter the maximum number of IPv4 addresses that can be allocated to a reseller
limit_ipv6addrs — IPv6 addresses. Enter the maximum number of IPv6 addresses that can be allocated to a reseller
limit_quota — Disk (MiB). Enter the maximum disk space in MB that can be used by files of this user
limit_traff — Traffic. Set a limit on the maximum amount of traffic allocated to WWW-domains and FTP-users per calendar month (from the first to the last date of the month)
limit_db — Databases. Enter the maximum number of databases that can be used by this user
limit_dbsize — Database size . Enter the maximum disk space size that can be allocated to the user's databases
limit_db_users — Database users. Enter the maximum number of database users that can this user can create
limit_ftp_users — FTP users. Enter the maximum number of FTP accounts that this user can create
limit_webdomains — WWW-domains. Enter the maximum number of WWW-domains that this user can create
limit_domains — Domain names. Enter the maximum number of of domain names (DNS) that this user can manage
limit_emaildomains — Mail domains. Enter the maximum number of mail domains that can be used by this user
limit_emails — Mailboxes . Enter the maximum number of mailboxes that can be used by this user
limit_cpu — CPU time. Sets a limit on CPU usage by user processes
limit_memory — RAM. Set a limit on the maximum amount of RAM allocated to this user
limit_process — User processes. Set a limit on the maximum number of processes allocated to this user
limit_email_quota — Mailbox maximum size. Enter the maximum size for the user's mailbox
limit_mailrate — Email limit . You can set the limit on the number of emails that can be sent from each mailbox per hour
limit_scheduler — Cron jobs. Enter the maximum number of cron jobs that can be created
limit_nginxlimitconn — Simultaneous connections per session. Set limit on the maximum number of simultaneous connections from a specific IP address that will be processed by the web-server
limit_maxclientsvhost — Apache handlers. Limits the maximum number of Apache handlers that process the user's WWW-domain
limit_mysql_maxuserconn — Simultaneous MySQL-connections. Set a limit on the maximum number of new simultaneous connections any individual user may have to the MySQL database per hour
limit_mysql_maxconn — MySQL-connections. Set a limit on the maximum number of connections any individual user may have to the MySQL database per hour
limit_mysql_query — MySQL queries. Set a limit on the maximum number of commands any individual MySQL-user may execute per hour
limit_mysql_update — MySQL update-query. Set a limit on the maximum number of commands modifying the data any individual MySQL-user may execute per hour
limit_cl_cpu — CPU load limit. Percentage of CPU utilization that occurred while executing at the user level.
limit_cl_nproc — Total number of processes. Enter the total number of processes allocated to each user
limit_cl_pmem — Physical memory. Enter the maximum amount of physical memory allocated to this user. Shared memory and disk cache used by user processes are also counted
limit_cl_io — I/O limit. I/O limit
limit_cl_maxentryprocs — LVE concurrent connections . Enter the maximum number of entries into LVE. We don't count processes that are already created
limit_cl_cagefs — . (Optional parameter. To enable the option click "on".) Enable CageFS for this user
limit_cl_php — PHP version. PHP version available to users
limit_charset — Domain encoding. Set default encoding
limit_php_mode — PHP mode. Default PHP mode
limit_php_cgi_version — Default PHP version (CGI) . Default PHP version that is used for scripts in CGI mode
limit_php_lsapi_version — Default PHP version for LSAPI. Select the PHP version that will be used for scripts running in the PHP as LSAPI mode
limit_dirindex — Index page. Default index page
limit_techdomain — Technical domains . Technical domain where the user is located
Set filter.
user.filter
Set filter by user
Function: user.happyfilter
Set filter by user
Access level: reseller+
View the history
Function: user.history
View the history
Access level: admin+ reseller
Suspend
Function: user.suspend
Suspend
Access level: admin+ reseller
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of user function.
The list object's parameters or additional query parameters (see above):
name — Login. Enter a username
fullname — Name . Enter a full name. You can enter a real name, organization name or any other information related to this account
preset — Template. Select a template. Its parameters will be applied automatically when creating a new reseller. Changing the template will change parameters for all resellers that were created based on that template
passwd — . Retype the password to change the reseller password. Leaving the field blank will not change the password
confirm — Re-enter password. Retype the password to ensure it is correct
create_time — Creation date.
limit_brand_domain — Domain for brand settings . Select a domain for reseller's brand settings
comment — .
limit_virusdie_autorun — . (Optional parameter. To enable the option click "on".) Automatically run a cron job for anti-virus scanning for user
limit_virusdie — . (Optional parameter. To enable the option click "on".) Allow a user to run anti-virus scanning with Virusdie, view check reports, and disinfect files. If this check box is not selected, reports and operations will be available only to admin
limit_ssl — . (Optional parameter. To enable the option click "on".) Select the check box to enable HTTPS for the WWW-domains of this user
limit_cgi — . (Optional parameter. To enable the option click "on".) Select the check box to activate CGI for WWW-domains of this user
limit_php_mode_mod — . (Optional parameter. To enable the option click "on".) Select the check box to activate PHP scripts for the WWW-domains of this user. The scripts will be executed with web-server's privileges. It is not secure because such scripts can access the information in the directory of other users.
limit_php_mode_lsapi — . (Optional parameter. To enable the option click "on".) The user will be able to create WWW-domains supporting PHP scripts. The scripts will be executed with user permissions and "LiteSpeed Technologies API for PHP" for Apache
limit_php_mode_cgi — . (Optional parameter. To enable the option click "on".) Select the check box to run PHP scripts for WWW-domains of this user. The scripts will be executed with privileges of the WWW-domain's owner (in the same way as CGI scripts)
limit_php_mode_fcgi_apache — . (Optional parameter. To enable the option click "on".) Select the check box to activate PHP scripts for the WWW-domains of this user. The scripts will be executed with user privileges using FastCGI (requests are processed by Apache) allowing for better performance. Update the web-server after the PHP parameters are modified
limit_php_mode_fcgi_nginxfpm — . (Optional parameter. To enable the option click "on".) Select the check box to activate PHP scripts for the WWW-domains of this user. The scripts will be executed with user privileges using FastCGI (Nginx will resend requests to the PHP-FPM processes manager ) allowing for better performance. Update the web-server after the PHP parameters are modified
limit_php_fpm_version — PHP version (PHP-FPM). Select the PHP version that will be used for scripts running as PHP-FPM
limit_shell — . (Optional parameter. To enable the option click "on".) Allow shell access to this server
limit_users — Users. The maximum number of user that this reseller can create
limit_resellertechdomain — Technical domains . Set the maximum number of technical domains that the reseller can create
limit_ipv4addrs — IPv4 addresses. Enter the maximum number of IPv4 addresses that can be allocated to a reseller
limit_ipv6addrs — IPv6 addresses. Enter the maximum number of IPv6 addresses that can be allocated to a reseller
limit_quota — Disk (MiB). Enter the maximum disk space in MB that can be used by files of this user
limit_traff — Traffic. Set a limit on the maximum amount of traffic allocated to WWW-domains and FTP-users per calendar month (from the first to the last date of the month)
limit_db — Databases. Enter the maximum number of databases that can be used by this user
limit_dbsize — Database size . Enter the maximum disk space size that can be allocated to the user's databases
limit_db_users — Database users. Enter the maximum number of database users that can this user can create
limit_ftp_users — FTP users. Enter the maximum number of FTP accounts that this user can create
limit_webdomains — WWW-domains. Enter the maximum number of WWW-domains that this user can create
limit_domains — Domain names. Enter the maximum number of of domain names (DNS) that this user can manage
limit_emaildomains — Mail domains. Enter the maximum number of mail domains that can be used by this user
limit_emails — Mailboxes . Enter the maximum number of mailboxes that can be used by this user
limit_cpu — CPU time. Sets a limit on CPU usage by user processes
limit_memory — RAM. Set a limit on the maximum amount of RAM allocated to this user
limit_process — User processes. Set a limit on the maximum number of processes allocated to this user
limit_email_quota — Mailbox maximum size. Enter the maximum size for the user's mailbox
limit_mailrate — Email limit . You can set the limit on the number of emails that can be sent from each mailbox per hour
limit_scheduler — Cron jobs. Enter the maximum number of cron jobs that can be created
limit_nginxlimitconn — Simultaneous connections per session. Set limit on the maximum number of simultaneous connections from a specific IP address that will be processed by the web-server
limit_maxclientsvhost — Apache handlers. Limits the maximum number of Apache handlers that process the user's WWW-domain
limit_mysql_maxuserconn — Simultaneous MySQL-connections. Set a limit on the maximum number of new simultaneous connections any individual user may have to the MySQL database per hour
limit_mysql_maxconn — MySQL-connections. Set a limit on the maximum number of connections any individual user may have to the MySQL database per hour
limit_mysql_query — MySQL queries. Set a limit on the maximum number of commands any individual MySQL-user may execute per hour
limit_mysql_update — MySQL update-query. Set a limit on the maximum number of commands modifying the data any individual MySQL-user may execute per hour
limit_cl_cpu — CPU load limit. Percentage of CPU utilization that occurred while executing at the user level.
limit_cl_nproc — Total number of processes. Enter the total number of processes allocated to each user
limit_cl_pmem — Physical memory. Enter the maximum amount of physical memory allocated to this user. Shared memory and disk cache used by user processes are also counted
limit_cl_io — I/O limit. I/O limit
limit_cl_maxentryprocs — LVE concurrent connections . Enter the maximum number of entries into LVE. We don't count processes that are already created
limit_cl_cagefs — . (Optional parameter. To enable the option click "on".) Enable CageFS for this user
limit_cl_php — PHP version. PHP version available to users
limit_charset — Domain encoding. Set default encoding
limit_php_mode — PHP mode. Default PHP mode
limit_php_cgi_version — Default PHP version (CGI) . Default PHP version that is used for scripts in CGI mode
limit_php_lsapi_version — Default PHP version for LSAPI. Select the PHP version that will be used for scripts running in the PHP as LSAPI mode
limit_dirindex — Index page. Default index page
limit_techdomain — Technical domains . Technical domain where the user is located
Suspend
Function: reseller.suspend
Suspend
Access level: admin+
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of reseller function.
Deny to create reseller's users on the cluster node
Function: reseller.allocation.suspend
Deny to create reseller's users on the cluster node
Access level: admin+
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of reseller.allocation function.
Allow to create reseller's users on the cluster node
Function: reseller.allocation.resume
Allow to create reseller's users on the cluster node
Access level: admin+
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of reseller.allocation function.
The list object's parameters or additional query parameters (see above):
ipaddr_input — IP, network, range . Enter IP addresses separated by commas, with subnet mask, in the format IP-address/subnet_mask. Addresses without masks will be created with mask /32
rules_select — Access . Rule type
reason_input — Reason . Reason for this rule (not more than 255 symbols)
Delete this access rule
Function: ddos_guard_view.accesslist.delete
Delete this access rule
Access level: super+
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of ddos_guard_view.accesslist function.
The list object's parameters or additional query parameters (see above):
changeauto — . (Optional parameter. To enable the option click "on".) When this option is enabled, web server settings and DNS settings for DDoS protection will be applied automatically.
ip_attack — . (Optional parameter. To enable the option click "on".) Enables/disables firewall prohibiting rules for ports 80 and 443. Access to websites (WWW-domains) is provided only for DDoS-GUARD servers. Domains without DDoS-GUARD protection are unaccessible from the Internet.
Add
Function: ddos_guard_view.edit
Add
Access level: super+
Disables DDoS protection by returning the default DNS settings in section Domain names. Use it if you'd like to check whether the DDoS attack has been finished.
Function: ddos_guard_view.suspend
Disables DDoS protection by returning the default DNS settings in section Domain names. Use it if you'd like to check whether the DDoS attack has been finished.
Access level: super+
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of ddos_guard_view function.
The list object's parameters or additional query parameters (see above):
seldomain — Domain . Domain to be added to DDoS protection
selip — IP addresses . Please specify one or several IP addresses. PLEASE NOTE: Changing this list will impact web domain settings.
Enables DDoS protection by changing DNS settings in section Domain names.
Function: ddos_guard_view.resume
Enables DDoS protection by changing DNS settings in section Domain names.
Access level: super+
Parameters:
elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of ddos_guard_view function.