ISPmanager API
For how to work with API functions, see the article Guide to ISPmanager software API.
Cluster nodes load
Function: sysinfo_stat
Result: report
Cluster nodes load
Access level: admin+
Whitelist
Function: whitelist
Result: the list of elements
Whitelist
Access level: admin+
- name — Sender
Whitelist rule
Function: whitelist.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:
- elid — unique identifier (name element of whitelist function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of whitelist function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name — Sender. Enter a sender
Delete the selected whitelist rule
Function: whitelist.delete
Delete the selected whitelist rule
Access level: admin+
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of whitelist function.
Result: successful operation or error message
Spamassassin configuration
Function: spamassassin
Access level: admin+
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
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
CloudLinux limits
Function: lve_stat
Result: report
CloudLinux limits statistics
Access level: admin+ user reseller
Function: lvesettings
Access level: admin+
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
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
- 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
Whitelist (Greylisting)
Function: greylist
Result: the list of elements
Whitelist (for Greylisting)
Access level: admin+ user
- name — Sender
Delete the selected rule from the Whitelist
Function: greylist.delete
Delete the selected rule from the Whitelist
Access level: admin+ user
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the origname element of greylist function.
Result: successful operation or error message
Whitelist rule
Function: greylist.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:
- elid — unique identifier (origname element of greylist function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (origname element of greylist function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name — Sender. Enter a sender
Settings
Function: backup.plan
Result: the list of elements
Backup plans
Access level: admin+ user
- name — Name
- type — Type
- state — Status
- cron — Schedule
Backup module settings
Function: backup.settings
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:
- elid — unique identifier (id element of backup.plan function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (id element of backup.plan function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- backuptmpdir — Temporary directory. Backup module directory containing the temporary files: archives, listing, etc.
- backuptimeout — Timeout. Set the maximum time out for data preparation (virtual machines)
Delete the selected backup plans
Function: backup.plan.delete
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:
- elid — unique identifier (id element of backup.plan function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (id element of backup.plan function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- clean_storages — . (Optional parameter. To enable the option click "on".) Select if you want to delete archives and listings from the storages
Run the backup process
Function: backup.plan.run
Run the backup process
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.plan function.
Result: successful operation or error message
Set filter.
backup.plan.datafilter
Set filter.
backup.plan.filter
Backup plan
Function: backup.plan.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:
- elid — unique identifier (id element of backup.plan function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (id element of backup.plan function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name — Name. Enter the name for the backup plan
- id — Internal name. Name that is used in archive names and for databases
- backup_type — Type. Backup type: Full, Incremental, Differential
- archiver — Archiver. Select an archiver
- 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
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
WWW-domains
Function: webdomain
Result: the list of elements
WWW-domains
Access level: admin+ user reseller
- prop — Parameters
- name — Name
- owner — Owner
- docroot — Root directory
- ipaddr — IP addresses
- php_mode — PHP mode
- php_version — PHP version
- comment — Comment
Name
Function: webdomain.error
Result: the list of elements
Error pages
Access level: admin+ user reseller
- code — Error code
- uri — URL
Delete
Function: webdomain.error.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 code element of webdomain.error function.
Result: successful operation or error message
Error page
Function: webdomain.error.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:
- plid — parent list unique identifier (name element of webdomain function).
- elid — unique identifier (code element of webdomain.error function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of webdomain function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of webdomain function).
- elid — unique identifier (code element of webdomain.error function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- code — Error code. Enter the error code
- uri — URL. Enter the error page that if open in case the error occurs
Open the selected domain in a browser.
Function: webdomain.go
Open the selected domain in a browser.
Access level: admin+ user reseller
Domain names connected to Cloudflare
Function: cloudflare.admin_list
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 webdomain function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of webdomain function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Open Site Builder
Function: sitepro_open
Open Site Builder
Access level: user
WWW-domain
Function: site.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 site function);
- Result: object parameters list.
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok";
- additional query parameters;
- Result: successful operation or error message.
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok";
- elid — unique identifier (name element of site function);
- additional query parameters;
- Result: successful operation or error message.
The list object's parameters or additional query parameters:
- site_name — WWW domain name;
- site_aliases — additional names for accessing the WWW domain (aliases). For example, www.example.com or wiki.example.com. By default, an alias "www.
" is entered after the domain name. - site_script_selector — script to install on a WWW domain;
- site_ssl_cert — SSL certificate to be used for WWW domain. You can specify an existing certificate or create a new self-signed certificate. Default value: letsencrypt. Possible values:
- selfsigned — new self-signed;
- ssl_not_used — do not use SSL certificate;
- letsencrypt — new Let's Encrypt certificate;
- certificate name;
- site_ipaddrs — server IP addresses that will be assigned to the WWW domain;
- site_owner — an ISPmanager user — owner of WWW-domain ;
- site_home — root WWW domain directory relative to the owner's home directory;
- site_foreground — whether the WWW domain is the default site. This option is used if several websites are assigned to the same IP address and a user requests a website using an IP address or domain name that is not registered on the server with ISPmanager. In this case, the control panel will open the default website. If this option is not specified for any website, the control panel will open the website whose domain name is the first alphabetically. The punycode encoding will be used to compare Cyrillic domain names. Default value: off.
- site_php_mode — PHP mode. Default value: php_mode_mod. Possible values:
- php_mode_cgi — CGI — dynamic content is processed by Apache in CGI mode;
- php_mode_fcgi_nginxfpm — FastCGI (Nginx + PHP-FPM) — PHP-FPM processes dynamic content;
- php_mode_fcgi_apache — FastCGI (Apache) — dynamic content is processed by Apache in FastCGI mode;
- php_mode_mod — Apache module — dynamic content is processed by the PHP module of the Apache web server;
- php_not_used — do not use;
- site_php_cgi_version — the version of PHP used to process scripts in CGI mode;
- site_php_apache_version — the version of PHP used in Apache module mode;
- site_php_fpm_version — the version of PHP used in FastCGI (Nginx + PHP-FPM) mode;
- lp_db_source — database in which the website information will be stored. Default value: db_not_use. Possible values:
- new_db — create a new database;
- db_not_use — do not use a database;
- database name and a server type:
Example of parameter
db1->MySQL
- db_server — database server type. Used if an existing database is selected;
- db_server_info — the address and port of the database server. Used if an existing database is selected. Default value: Server address: localhost. Port: 3306;
- db_name — database name. Used if an existing database is selected;
- db_user — create a new database user or use an existing one. Used if an existing database is selected. Default value: new_db_user. Possible values:
- new_db_user — create a new database user;
- existing user name;
- db_username — the name of the new database user. Used if an existing database is selected and the db_user parameter is equal to new_db_user;
- db_password — the password of the new database user. Used if an existing database is selected and the db_user parameter is equal to new_db_user;
- lp_edit_db_server — database server type. Used when a new database needs to be created;
- lp_edit_db_server_info — the address and port of the database server. Used when a new database needs to be created;
- lp_edit_db_username — database user name. Used when a new database needs to be created;
- lp_edit_db_password — database user password. Used when a new database needs to be created;
- site_srv_gzip — whether to compress the static content of the WWW domain. Default value: on. Possible values:
- on — compress;
- off — do not compress;
- site_gzip_level — the compression level of static content. Default value: 5. Possible values: from 1 (minimum compression level) to 9 (maximum compression level);
- site_srv_cache — whether to cache the content of the site. Default value: on. Possible values:
- on — cache;
- off — do not cache;
- site_expire_times — cache period units. Default value: expire_times_h. Possible values:
- expire_times_s — seconds;
- expire_times_m — minutes;
- expire_times_h — hours;
- expire_times_d — days;
- expire_times_max — the period is not limited;
- site_expire_period — cache period. Default value: 24. Possible values: from 0 to 365;
- site_ddosshield — enabling protection against DDoS attacks with the ngx_http_limit_req_module module;
- site_nginx_limitrequest — maximum number of requests per second from one IP address - if this parameter is exceeded, the IP address is blocked for 5 minutes. The default value is 25. Possible values: from 2 to 10000;
- site_nginx_burstrequest — maximum burst size — the number of requests per second above which new requests are blocked. The default value is 100. Possible values: from 2 to 10000;
- site_autosubdomain — auto subdomain setting. Default value: off. Possible values:
- off — do not create subdomains;
- autosubdomain_dir — create in a separate directory;
- autosubdomain_subdir — create in the domain's subdirectory;
- site_email — WWW domain administrator email. Default value: webmaster@domainname.
- site_redirect_http — redirects HTTP requests to HTTPS. Default value: off. Possible values:
- on — redirect;
- off — do not redirect;
- site_ssl_port — TCP port for HTTPS connections. Default value: 443. Possible values: from 1 to 65535.
- site_charset — default encoding for WWW domain. Default value: off. Possible values:
- off — to use the default value for the database;
- UTF-8;
- site_dirindex — index pages of the WWW domain. Default value: index.php index.html;
- site_hsts — to force a secure HTTPS connection. Default value: off. Possible values:
- on — enable;
- off — disable;
- site_ssi — whether to process SSI commands to the server. Default value: off. Possible values:
- on — process;
- off — do not process;
- site_basedir — whether to use open_basedir for Apache module PHP mode. Default value: on. Possible values:
- on — PHP scripts have access only to the root directory of the website;
- off — PHP scripts have access to all server directories;
- site_cgi — CGI scripts support. Default value: off. Possible values:
- on — enable;
- off — disable;
- site_cgi_ext — file extensions for CGI scripts;
- lp_journals — logs to be kept for the WWW domain. Default value: journal_error_and_request. Possible values:
- journal_none — do not keep logs;
- journal_error_and_request — error log and request log;
- journal_error — error log;
- journal_request — request log;
- site_rotation_period — log rotation period. Default value: every_day. Possible values:
- every_day — daily;
- every_week — weekly;
- every_month — monthly;
- by_size — by size;
- site_rotation_size — log size in MB, at which to rotate the log. Default value: 100. Possible values: from 1 to 2000;
- site_rotation_count — the number of log files that will be stored in the archived form. Default value: 10. Possible values: from 0 to 1000;
- site_analyzer — report generator that will be used to collect statistics. Default value: off. Possible values:
- off — do not use;
- awstats;
- site_analyzer_period — the period of gathering statistics on requests. Default value: rotate. Possible values:
- rotate — during rotation ;
- every_hour — hourly;
- every_day — daily;
- every_week — weekly;
- every_month — monthly;
- site_analyzer_lang — statistics language;
- site_analyzer_secure — enable access to statistics reports by password. Default value: on. Possible values:
- on — enable;
- off — disable;
- site_analyzer_passwd — password to access the statistics;
- site_analyzer_confirm — re-entering the password to access the statistics.
Function: webdomain.edit
Option ForceEnableNewSiteForm
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 webdomain function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of webdomain function)
- additional query parameters ...
- Result: successful operation or error message
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.
- confirm — confirm operation: on — confirm.
Result: successful operation or error message
Open the WWW-domain's directory in the file manager
Function: webdomain.file
Open the WWW-domain's directory in the file manager
Access level: super user
Name
Function: webdomain.diraccess
Result: the list of elements
Protecting directory
Access level: admin+ user reseller
- path — Directory
Add
Function: webdomain.diraccess.add
Add
Access level: admin+ user reseller
Delete
Function: webdomain.diraccess.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 path element of webdomain.diraccess function.
Result: successful operation or error message
Username
Function: webdomain.diraccess.user
Result: the list of elements
Users of the password protected directory
Access level: admin+ user reseller
- name — Username
- status — Status
Suspend
Function: webdomain.diraccess.user.suspend
Suspend
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.
Result: successful operation or error message
Delete
Function: webdomain.diraccess.user.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.diraccess.user function.
Result: successful operation or error message
User
Function: webdomain.diraccess.user.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:
- plid — parent list unique identifier (path element of webdomain.diraccess function).
- elid — unique identifier (name element of webdomain.diraccess.user function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (path element of webdomain.diraccess function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (path element of webdomain.diraccess function).
- elid — unique identifier (name element of webdomain.diraccess.user function)
- additional query parameters ...
- Result: successfull operation or error message
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.
Result: successful operation or error message
Suspend
Function: webdomain.suspend
Suspend
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.
Result: successful operation or error message
View the WWW-domain's access statistics. Enter the password to access, if needed.
Function: webdomain.stat
View the WWW-domain's access statistics. Enter the password to access, if needed.
Access level: admin+ user reseller
WWW-domain configuration files
Function: webdomain.plain
Access level: admin super
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 webdomain function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of webdomain function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- apache_data — .
- apache_data — .
- nginx_data — .
- nginx_data — .
Drill down to User panel
Function: webdomain.su
Drill down to User panel
Access level: admin+ user reseller
Set filter.
webdomain.filter
Cloudflare
Function: cloudflare
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 webdomain function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of webdomain function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Redirect of WWW domain
Function: webdomain.redirect
Result: the list of elements
Redirects
Access level: admin+ user reseller
- path — Path
- url — URL
Redirect
Function: webdomain.redirect.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:
- plid — parent list unique identifier (name element of webdomain function).
- elid — unique identifier (path element of webdomain.redirect function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of webdomain function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of webdomain function).
- elid — unique identifier (path element of webdomain.redirect function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- status — Redirect code. Enter the redirect code
- path — Path. Enter a relative path that will be redirected to the other URL
- url — URL. Enter the URL for redirect
Delete
Function: webdomain.redirect.delete
Delete
Access level: admin+ user reseller
Parameters:
- elid — one or more object's unique identifiers delimited with space. The unique identifiers is the path element of webdomain.redirect function.
- plid — domain from which redirect is performed
Result: successful operation or error message
Resume
Function: webdomain.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 function.
Result: successful operation or error message
IP-address pool
Function: ipdb
Result: the list of elements
IP-address pool
Access level: admin+
- range — IP address range
- iptype — IP address group
- gateway — Gateway
- netmask — Network mask
Set filter.
ipdb.filter
Delete the range
Function: ipdb.delete
Delete the range
Access level: admin+
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the range element of ipdb function.
Result: successful operation or error message
Range parameters
Function: ipdb.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:
- elid — unique identifier (range element of ipdb function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (range element of ipdb function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- range — IP address range. The range of IP addresses — network_address/network_mask, first_address-last_address or a single address
- netmask — Network mask . The network mask. It is used by other control panel for network settings
- gateway — Gateway . Enter a gateway address. It is used by other software products for network configuration.
- iptype — IP address group. Type of IP addresses that is used by this control panel
Name
Function: ipdb.addr
Result: the list of elements
IP addresses
Access level: admin+
- ip — IP address
- domain — Domain name
- xtype — Address type
IP address
Function: ipdb.addr.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 (range element of ipdb function).
- elid — unique identifier (ip element of ipdb.addr function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (range element of ipdb function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (range element of ipdb function).
- elid — unique identifier (ip element of ipdb.addr function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- ip — IP address. The IP address which properties you are editing
- domain — Domain name. The domain name associated with this IP address
Enter a special address
Function: ipdb.addr.delete
Enter a special address
Access level: admin+
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the ip element of ipdb.addr function.
Result: successful operation or error message
Special domain names
Function: ipdb.settings
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 (range element of ipdb function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (range element of ipdb function)
- additional query parameters ...
- Result: successful operation or error message
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
Email filter
Function: email.sorter
Result: the list of elements
Email filtering
Access level: 9
- name — Filter name
- allany — Condition
- properties — Properties
Add a new email filter
Function: addsorter
Add a new email filter
Access level: 9
Email filtering
Function: email.sorter.edit
Access level: 9
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 (id element of email.sorter function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (id element of email.sorter function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name — Email filter name. Enter the name for the filter
- condcomp — Conditions. Select how filter conditions will be compared, logical operators AND/OR.
- pos — Place before. Position of the filter condition, they are executed one after another
Resume
Function: email.sorter.resume
Resume
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 function.
Result: successful operation or error message
Delete the selected email filters
Function: email.sorter.delete
Delete the selected email filters
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 function.
Result: successful operation or error message
Name
Function: email.sorter.action
Result: the list of elements
Filter action
Access level: 9
- action — Action
- actval — Value
Actions
Function: email.sorter.action.edit
Access level: 9
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 (id element of email.sorter function).
- elid — unique identifier (id element of email.sorter.action function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of email.sorter function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of email.sorter function).
- elid — unique identifier (id element of email.sorter.action function)
- additional query parameters ...
- Result: successfull operation or error message
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.
Result: successful operation or error message
Suspend
Function: email.sorter.suspend
Suspend
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 function.
Result: successful operation or error message
Name
Function: email.sorter.cond
Result: the list of elements
Email filter conditions
Access level: 9
- what — Parameter
- mod — Rule
- param — Values
Filter rule
Function: email.sorter.cond.edit
Access level: 9
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 (id element of email.sorter function).
- elid — unique identifier (id element of email.sorter.cond function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of email.sorter function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of email.sorter function).
- elid — unique identifier (id element of email.sorter.cond function)
- additional query parameters ...
- Result: successfull operation or error message
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.
Result: successful operation or error message
PHP setup
Function: phpinstall
Result: the list of elements
PHP setup
Access level: admin+
- name — PHP version
- props — Status
- mod_cgi — CGI
- mod_apache — Apache module
- mod_fpm — FastCGI (Nginx + PHP-FPM)
Install the selected PHP version
Function: phpinstall.install
Install the selected PHP version
Access level: admin+
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the key element of phpinstall function.
Result: successful operation or error message
Delete the selected PHP version
Function: phpinstall.uninstall
Delete the selected PHP version
Access level: admin+
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the key element of phpinstall function.
Result: successful operation or error message
Change the PHP build
Function: phpinstall.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:
- elid — unique identifier (key element of phpinstall function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (key element of phpinstall function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- package_installed — Activation of PHP of the selected version . Select if you want to use PHP or not
- fpm_installed — Fpm data. (Optional parameter. To enable the option click "on".) PHP as FastCGI (Nginx + PHP-FPM)
- apache_installed — Apache data. (Optional parameter. To enable the option click "on".) PHP as an Apache module
Name of the cluster node
Function: phpinstall.details
Result: the list of elements
Setup status
Access level: admin+
- name — Name of the cluster node
- props — Status
Name
Function: phpinstall.details.actions
Result: the list of elements
Actions performed on the cluster node
Access level: admin+
- num — Order
- act_type — Action
- act_dest — Goal
- props — Status
- last_error — Error
Virusdie
Function: virusdie_trial
Result: the list of elements
Virusdie trial version
Access level: super
- started — Start date
- duration — Duration
- files — Checked files
- threats — Threats
- curable — Can be disinfected
- treated — Cured
- errors — Errors
- status — Status
Name
Function: virusdie_trial.threatlist
Result: the list of elements
Threads
Access level: super
- filename — File name
- threatid — Thread ID
- threatname — Threat name
- curestate — Result
- status — Status
Set filter.
virusdie_trial.threatlist.filter
Show the infected code section. Available in full version
Function: virusdie_trial.stub
Show the infected code section. Available in full version
Access level: super
Delete
Function: virusdie_trial.delete
Delete
Access level: super
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of virusdie_trial function.
Result: successful operation or error message
Full server scan (trial)
Function: virusdie_trial.run
Full server scan (trial)
Access level: super
Virusdie settings
Function: virusdie.settings
Access level: super
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 (id element of virusdie_trial function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (id element of virusdie_trial function)
- additional query parameters ...
- Result: successful operation or error message
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
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
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
Technical domains
Function: techdomain
Result: the list of elements
Technical domains
Access level: admin+ reseller
- name — Name
- owner — Owner
- status — Status
- comment — Comment
Technical domains
Function: techdomain.edit
Access level: admin+ 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 techdomain function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of techdomain function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name — Name. Enter a name for the technical domain
- owner — Owner. Owner of the technical domain
- ns — Name servers. Name severs associated with this domain name
- comment — Comment. Enter detailed description, notes, etc.
Delete
Function: techdomain.delete
Delete
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 function.
Result: successful operation or error message
Move users between technical domains
Function: techdomain.relocate
Access level: admin+ 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 techdomain function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of techdomain function)
- additional query parameters ...
- Result: successful operation or error message
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
Name
Function: techdomain.records
Result: the list of elements
Technical domain records
Access level: admin+ reseller
- name — Name
- rtype — Type
- value — Value
- info — Additional information
Delete the selected DNS record.
Function: techdomain.records.delete
Delete the selected DNS record.
Access level: admin+ reseller
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the rkey element of techdomain.records function.
Result: successful operation or error message
Domain record
Function: techdomain.records.edit
Access level: admin+ 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 (name element of techdomain function).
- elid — unique identifier (rkey element of techdomain.records function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of techdomain function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of techdomain function).
- elid — unique identifier (rkey element of techdomain.records function)
- additional query parameters ...
- Result: successfull operation or error message
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
Username
Function: techdomain.users
Result: the list of elements
Technical domain users
Access level: admin+ reseller
- name — Username
- webdomain — WWW-domain
- ipaddrs — IP addresses
- status — Status
Technical domain user properties
Function: techdomain.users.edit
Access level: admin+ 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 (name element of techdomain function).
- elid — unique identifier (name element of techdomain.users function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of techdomain function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of techdomain function).
- elid — unique identifier (name element of techdomain.users function)
- additional query parameters ...
- Result: successfull operation or error message
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.
Result: successful operation or error message
User data
Function: cloudflare.usersettings
Access level: user
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- email — Mailbox. Enter the mailbox of Cloudflare user
- password — Password. Enter the password of Cloudflare user
Databases
Function: db
Result: the list of elements
Databases
Access level: admin+ user reseller
- pair — Username and database name in "user->base" format
- name — Name
- owner — Owner
- node — Current location
- type — Database server type
- dbhost — Database server URL
- user_count — Number of users
- size — Size, MiB
- status — Status
- comment — Comment
- is_local -
Set filter.
db.filter
Name
Function: db.users
Result: the list of elements
Database users
Access level: admin+ user reseller
- name — Name
- perm — Privileges
Parameters:
- elid — pair element of db function.
Delete
Function: db.users.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 db.users function.
Result: successful operation or error message
Database user
Function: db.users.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:
- plid — parent list unique identifier (key element of db function).
- elid — unique identifier (name element of db.users function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (key element of db function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (key element of db function).
- elid — unique identifier (name element of db.users function)
- additional query parameters ...
- Result: successfull operation or error message
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)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (pair element of db function)
- additional query parameters ...
- Result: successful operation or error message
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)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (key element of db function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name — Name. The name of the database that will be used for the import.
- owner — Owner. Select a control panel user who will be the owner of the database
- server — Database server. Database server type.
Database owner change
Function: passdb
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)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (key element of db function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- sysdbusers — System database users . Users that can access the system database
- dbname — Database name . The owner will be changed for the selected database
- dbadd — Additional databases . The owner will be also changed for additional databases
- new_owner — New owner . Select a new owner of the database
Delete
Function: db.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 key element of db function.
Result: successful operation or error message
Upload database dump
Function: db.upload
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)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (key element of db function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name — Name. The name of the database that will be used for the import.
- owner — Owner. Select a control panel user who will be the owner of the database
- server — Database server. Database server type.
- type — Upload type. Select the upload type you want to use. You can upload files from your local computer or from a remote server.
- url — URL. Enter the URL to the file that you want to upload. For example, http://example.com/dir/sql .
Filter by owner
Function: db.happyfilter
Filter by owner
Access level: reseller+
Perl extensions
Function: perlext
Result: the list of elements
Perl extensions
Access level: admin+
- name — Name
- properties — Properties
Set filter.
perlext.filter
Install extension
Function: perlext.install
Install extension
Access level: admin+
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of perlext function.
Result: successful operation or error message
Delete extension
Function: perlext.uninstall
Delete extension
Access level: admin+
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of perlext function.
Result: successful operation or error message
Scheduler (cron)
Function: scheduler
Result: the list of elements
Scheduler
Access level: super user
- command — Command
- interval — Period
- schedule_type — Scheduler
- state — Status
- description — Description
OS installation
Function: scheduler.prop
Access level: super 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 (key element of scheduler function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (key element of scheduler function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- mailto — Email. Enter the email address that will be used for notifications about your cronjobs.
- path — Path. Enter one or more paths (space separated) that will be used to search for executables.
Execute command
Function: run
Access level: super 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 (key element of scheduler function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (key element of scheduler function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- command — Command. Enter command(s) that will start in the server OS
- path — Directory . Select a directory where the command will start
Delete
Function: scheduler.delete
Delete
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.
Result: successful operation or error message
Crob job
Function: scheduler.edit
Access level: super 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 (key element of scheduler function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (key element of scheduler function)
- additional query parameters ...
- Result: successful operation or error message
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.
Result: successful operation or error message
Resume
Function: scheduler.resume
Resume
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.
Result: successful operation or error message
User import
Function: backup2.list.import
Access level: user
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
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
Disk usage
Function: diskusage
Result: the list of elements
Disk usage
Access level: user
- name — Directory
- fullsize — All files size
- ownersize — User files size
OS installation
Function: diskusage.info
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 diskusage function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of diskusage function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- homedir — Home directory . The total size of all files and folders that are located in the home folder.
- userlogs — WWW logs. Total size of the WWW-log files .
Open the selected folder in the file manager.
Function: diskusage.file
Open the selected folder in the file manager.
Access level: user
User import
Function: backup2.superlist.import
Access level: admin+
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
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
User traffic
Function: user_traff_stat
Result: report
Traffic consumption by users
Access level: admin+ reseller
PHP
Function: phpversions
Result: the list of elements
PHP
Access level: admin+ user
- name — PHP version
- mod_cgi — Status
- mod_apache — Apache module
- mod_fpm — FastCGI (Nginx + PHP-FPM)
Now it is used as PHP-FMP
Function: setuserfpm
Now it is used as PHP-FMP
Access level: user
PHP extensions
Function: phpextensions
Result: the list of elements
PHP extensions
Access level: admin+ user
- name — Name
- properties — Properties
Install extension
Function: phpextensions.install
Install extension
Access level: admin+ user
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of phpextensions function.
Result: successful operation or error message
Name of the cluster node
Function: phpextensions.details
Result: the list of elements
Setup status
Access level: admin+ user
- name — Name of the cluster node
- props — Status
Enable the selected extension.
Function: phpextensions.resume
Enable the selected extension.
Access level: admin+ user
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of phpextensions function.
Result: successful operation or error message
Disable the selected extension.
Function: phpextensions.suspend
Disable the selected extension.
Access level: admin+ user
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of phpextensions function.
Result: successful operation or error message
Delete extension
Function: phpextensions.uninstall
Delete extension
Access level: admin+ user
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of phpextensions function.
Result: successful operation or error message
PHP settings
Function: phpconf
Result: the list of elements
PHP settings
Access level: admin+ user
- module — Module name
- name — Variable name
- value — Value
- apache_value — Apache value
- cgi_value — CGI value
- fpm_value — PHP-FPM value
- state — Status
- elid=
— PHP settings for the WWW domain
Restore the default parameter
Function: phpconf.default
Restore the default parameter
Access level: admin+ user
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of phpconf function.
Result: successful operation or error message
Set filter.
phpconf.filter
PHP configuration
Function: phpconf.settings
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)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (key element of phpversions function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (key element of phpversions function).
- elid — unique identifier (name element of phpconf function)
- additional query parameters ...
- Result: successfull operation or error message
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)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (key element of phpversions function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (key element of phpversions function).
- elid — unique identifier (name element of phpconf function)
- additional query parameters ...
- Result: successfull operation or error message
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.
- plid=
elid=max_execution_time — View/change the max_execution_time parameter for the WWW domain
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.
Result: successful operation or error message
The selected parameter will be available to users
Function: phpconf.resume
The selected parameter will 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.
Result: successful operation or error message
Activate the selected PHP version.
Function: setusercgi
Activate the selected PHP version.
Access level: user
Use the Apache module of the selected PHP version
Function: setapache
Use the Apache module of the selected PHP version
Access level: admin+ user
Site Builder
Function: sitepro_admin
Access level: admin+
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Cluster nodes
Function: node
Result: the list of elements
Cluster nodes
Access level: admin+
- name — Name
- mainip — IP address
- usercount — Users
- assign_prio — Priority
- managerver — Panel version
- state — Status
- resources — Resources
- comment — Comment
- roles — Roles
Docker updates
Function: check_docker_update
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)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of node function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- delayed_launch — . (Optional parameter. To enable the option click "on".) Delayed start of updates of Docker-containers
- start_date — Date. Verification and update start date
- start_hr — Hour . Select the time of the verification and update
- start_min — Minutes . Select the time of the verification and update
Name
Function: node.licinfo
Result: the list of elements
License keys
Access level: admin+
- licinfo — Key
- node — Cluster node
- state — Properties
- comment -
License key
Function: node.licinfo.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 node function).
- elid — unique identifier (id element of node.licinfo function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of node function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of node function).
- elid — unique identifier (id element of node.licinfo function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- licinfo — Key. License key
- comment — .
Delete
Function: node.licinfo.delete
Delete
Access level: admin+
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of node.licinfo function.
Result: successful operation or error message
Temporary deny requests to the node (e.g. during maintenance )
Function: node.stop
Temporary deny requests to the node (e.g. during maintenance )
Access level: admin+
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of node function.
Result: successful operation or error message
File manager
Function: file
Result: the list of elements
File manager
Access level: user super
Signatures
Function: virusdie.signatures.filemgr
Access level: user super
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 node function).
- elid — unique identifier (name element of file function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of node function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of node function).
- elid — unique identifier (name element of file function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- error_type — Error type . Error type during file check
Diagnostics of modules of the cluster node control panel
Function: node.notloaded
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)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of node function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Cluster node log
Function: node.infomsg
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)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of node function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Check connection with cluster node
Function: node.checkavail
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)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of node function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Set filter.
node.filter
IP addresses
Function: ipaddr
Result: the list of elements
IP addresses
Access level: admin+
- name — IP address
- node — Server
- iprole — Role
- owner — Owner
- domain — Default WWW-domain
- state — Properties
- comment — Comment
Delete the selected IP addresses
Function: ipaddr.delete
Delete the selected IP addresses
Access level: reseller+
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of ipaddr function.
Result: successful operation or error message
Release IP address
Function: ipaddr.free
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:
- plid — parent list unique identifier (name element of node function).
- elid — unique identifier (name element of ipaddr function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of node function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of node function).
- elid — unique identifier (name element of ipaddr function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- old_ip — IP address. Select an IP address that you want to release
- new_ip — New IP address . New IP address for the items that are using this IP
Filter by owner
Function: ipaddr.happyfilter
Filter by owner
Access level: reseller+
Set filter.
ipaddr.filter
User
Function: ipaddr.mutualaccess
Result: the list of elements
Access to shared IP address
Access level: admin+
- name — User
- level — User role
- prop — Access
Allow access to the IP address
Function: ipaddr.mutualaccess.resume
Allow access to the IP address
Access level: admin+
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of ipaddr.mutualaccess function.
Result: successful operation or error message
Deny access to the IP address
Function: ipaddr.mutualaccess.suspend
Deny access to the IP address
Access level: admin+
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of ipaddr.mutualaccess function.
Result: successful operation or error message
IP address
Function: ipaddr.edit
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:
- plid — parent list unique identifier (name element of node function).
- elid — unique identifier (name element of ipaddr function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of node function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of node function).
- elid — unique identifier (name element of ipaddr function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- iptype — IP address allocation. Select an IP address allocation mechanism
- name — IP address. Enter an IP address that you want to add
- netmask — Network mask . Enter a network mask of the new IP address
- gateway — Gateway IP address. Enter gateway IP for the new IP address
- subnet — Subnet. Choose a subnet from which you want to allocate an IP address
- ipv4pool — Pool of IPv4 address . Enter a pool of IPv4 addresses to allocate an IP address from
- ipv6pool — Pool of IPv6 addresses . Enter a pool of IPv4 addresses to allocate an IP address from
- iprole — Role. Select the role for the IP address in the control panel
- node — Server. Select a cluster node to add the IP address
- owner — Owner. Select the owner of this IP address
- comment — Comment. Enter any additional information related to this IP address
Delete
Function: node.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 node function.
Result: successful operation or error message
Active connections
Function: netactconn
Result: the list of elements
Active network connections
Access level: admin+
- appname — Process name
- count — Number of connections
Name
Function: netactconn.detail
Result: the list of elements
Active network connections
Access level: admin+
- localip — Local IP address
- localport — Local port
- remoteip — Remote IP address
- remoteport — Remote port
- proto — Protocol
- threads — Number of threads
- country — Country
Name
Function: netactconn.detail.showbycountry
Result: the list of elements
Connections per country
Access level: admin+
- count — Number of connections
- country — Country
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.
Result: successful operation or error message
Name
Function: netactconn.detail.showbysubnet
Result: the list of elements
Connections per subnet
Access level: admin+
- count — Number of connections
- subnet — Subnet
Edit the selected rule
Function: netactconn.detail.showbysubnet.adddenysubnet
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 (remoteip element of netactconn.detail function).
- elid — unique identifier (subnet element of netactconn.detail.showbysubnet function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (remoteip element of netactconn.detail function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (remoteip element of netactconn.detail function).
- elid — unique identifier (subnet element of netactconn.detail.showbysubnet function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- action — Action. Select what you want to do with the packages sent from the IP address specified below
- proto — Protocol. Select a protocol
- port — Port. Enter the port number.
- denyall — . (Optional parameter. To enable the option click "on".) Deny access for all IP addresses, except for the specified
- src_net — Source address (network). Network address format: 8.8.8.0/24
- src_ip — IP address. You can enter a single IP address or a network (8.8.8.0/24)
- deny_ips — Denied IP addresses. Enter IP addresses that cannot access this network
- allow_ips — Allowed IP addresses. Enter IP addresses that can access this network
- comment — Comment. Enter detailed description, notes, etc.
SSL key
Function: email.toplevel.ssl.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:
- elid — unique identifier (name element of node function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of node function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- crt — Certificate. Domain certificate in the PEM format
- key — Certificate key. Enter the certificate key in the PEM format
- cacrt — Certificate chain. Certificate chain in the PEM format
Name
Function: node.synclist
Result: the list of elements
Active syncs
Access level: admin+
- name — Name
- prio — Priority
- status — Status
- count — Earlier starts
- sync_result — Last result
Name
Function: node.synclist.details
Result: the list of elements
Synchronization attempt
Access level: admin+
- num — Number
- end_time — Completion date
- sync_result — Result
- status — Status
- error_msg — Reply error
Information about synchronization attempts
Function: node.synclist.details.show
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 (id element of node.synclist function).
- elid — unique identifier (id element of node.synclist.details function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of node.synclist function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of node.synclist function).
- elid — unique identifier (id element of node.synclist.details function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- node — Cluster node. The cluster node for which the synchronization was made
- end_time — Completion date .
- error_msg — Error message: . The error message that occurred during the synchronization process
- log — Log: . Synchronization thread log
Cluster node
Function: node.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:
- elid — unique identifier (name element of node function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of node function)
- additional query parameters ...
- Result: successful operation or error message
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)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of node function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Reboot the selected node
Function: node.reboot
Reboot the selected 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 node function.
Result: successful operation or error message
Shell access this cluster node
Function: shellclient
Shell access this cluster node
Access level: admin+
Change IP address for the selected cluster node
Function: node.changemainip
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)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of node function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- curip — Current IP address . Current IP address of the cluster node
- newip — New IP address. New IP address of the cluster node
Services
Function: services
Result: the list of elements
Services
Access level: admin+
- name — Name
- status — Status
List of services which current status was not defined
Function: services.unknown
List of services which current status was not defined
Access level: admin+
Stop the selected service
Function: services.suspend
Stop the selected 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.
Result: successful operation or error message
Monitoring system settings
Function: monitoring.add
Access level: edit: 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 node function).
- elid — unique identifier (name element of services function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of node function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of node function).
- elid — unique identifier (name element of services function)
- additional query parameters ...
- Result: successfull operation or error message
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.
Result: successful operation or error message
Monitoring system settings
Function: monitoring.settings
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 node function).
- elid — unique identifier (name element of services function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of node function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of node function).
- elid — unique identifier (name element of services function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- mon — . (Optional parameter. To enable the option click "on".) This function can be used to monitor current statuses of running services
- period — Period. Select period to get information from the service
Include/exclude the service from the list
Function: services.exclude
Include/exclude the service from the list
Access level: admin+
Start the selected service
Function: services.resume
Start the selected 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.
Result: successful operation or error message
Enter the name for the service process
Function: services.setbin
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 node function).
- elid — unique identifier (name element of services function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of node function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of node function).
- elid — unique identifier (name element of services function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- name — Service name. Select a service for which you want to specify a process name
- bin — Service process name . Enter the name of the service process
- pid — Path to the PID-file. Path to the PID-file
- restart — Service restart command parameter . Enter the parameter that will be passed to the command for service restart. The default value is restart
Set filter.
services.filter
Disable monitoring for this service
Function: monitoring.remove
Disable monitoring 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.
Result: successful operation or error message
Update statuses for all services
Function: services.refresh
Update statuses for all services
Access level: admin+
Enable auto-start for this service
Function: services.enable
Enable 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.
Result: successful operation or error message
Restart the selected service
Function: services.restart
Restart the selected 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.
Result: successful operation or error message
Name
Function: node.allocation
Result: the list of elements
Resellers and templates allocation among cluster nodes
Access level: admin+
- name — Name
- type — Type
- count — Users
- state — Status
- roles — Missing roles
Disable creation of new users on the cluster node
Function: node.allocation.suspend
Disable creation of new 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 key element of node.allocation function.
Result: successful operation or error message
Enable creation of new users on the cluster node
Function: node.allocation.resume
Enable creation of new 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 key element of node.allocation function.
Result: successful operation or error message
Network services
Function: netsrv
Result: the list of elements
Network services
Access level: admin+
- appname — Service name
- proto — Protocol
- ports — Ports
Add rule
Function: netsrv.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 node function).
- elid — unique identifier (key element of netsrv function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of node function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of node function).
- elid — unique identifier (key element of netsrv function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- action — Action. Select what you want to do with the packages sent from the IP address specified below
- proto — Protocol. Select a protocol
- port — Port. Enter the port number.
- denyall — . (Optional parameter. To enable the option click "on".) Deny access for all IP addresses, except for the specified
- src_net — Source address (network). Network address format: 8.8.8.0/24
- src_ip — IP address. You can enter a single IP address or a network (8.8.8.0/24)
- deny_ips — Denied IP addresses. Enter IP addresses that cannot access this network
- allow_ips — Allowed IP addresses. Enter IP addresses that can access this network
- comment — Comment. Enter detailed description, notes, etc.
Server name
Function: nodedbserver
Result: the list of elements
Database servers of the cluster node
Access level: admin+
- name — Server name
- type — Server type
- status — Status
- version — Software version
- addr — URL
Parameter name
Function: db.server.settings
Result: the list of elements
Database server configuration
Access level: admin+
- name — Parameter name
- value — Parameter value
- default_value — Default value
- status — Status
- addition — Additional information
Reset parameter to the default value
Function: db.server.settings.flush
Reset parameter to the default value
Access level: admin+
Database server parameter
Function: db.server.settings.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 (key element of nodedbserver function).
- elid — unique identifier (name element of db.server.settings function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (key element of nodedbserver function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (key element of nodedbserver function).
- elid — unique identifier (name element of db.server.settings function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- name — Parameter name . Configuration file name of the database server
- default_value — Default value . Parameter default value
- use_default — . (Optional parameter. To enable the option click "on".) Reset this parameter to the default value
- int_value — Parameter value . Enter the value for parameter of the database server configuration file
- bool_value — Parameter value . Enter the value for parameter of the database server configuration file
- use_custom — . (Optional parameter. To enable the option click "on".) You may enter an arbitrary value for this parameter with verifying its type
- str_value — Parameter value . Enter the value for parameter of the database server configuration file
Database server
Function: db.server.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 node function).
- elid — unique identifier (name element of db.server function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of node function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of node function).
- elid — unique identifier (key element of nodedbserver function)
- additional query parameters ...
- Result: successfull operation or error message
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
Database name
Function: db.server.dbunassigned
Result: the list of elements
Unassigned databases
Access level: admin+
- name — Database name
Delete
Function: db.server.dbunassigned.delete
Delete
Access level: admin+
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of db.server.dbunassigned function.
Result: successful operation or error message
Allow requests to the cluster node
Function: node.start
Allow requests to 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 node function.
Result: successful operation or error message
Forbid creation of new users on this cluster node
Function: node.lock
Forbid creation of new users on this 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 node function.
Result: successful operation or error message
Allow creating new users on the cluster node
Function: node.unlock
Allow creating new 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 node function.
Result: successful operation or error message
Domain names
Function: domain
Result: the list of elements
Domain names (DNS)
Access level: admin+ user reseller
- displayname — Domain name
- user — Owner
- status — Status
- comment -
Drill down to panel of the domain's owner
Function: domain.su
Drill down to panel of the domain's owner
Access level: admin+ user reseller
Name
Function: domain.dnssecinfo
DNSSEC parameters
Access level: admin+ user reseller
Update information about this domain name on the secondary name servers
Function: domain.fix
Update information about this domain name on the secondary name servers
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 domain function.
Result: successful operation or error message
Name
Function: domain.record
Result: the list of elements
DNS record types
Access level: admin+ user reseller
- name — Name
- ttl — TTL, sec
- rtype — Type
- value — Value
- info — Additional information
Delete the selected DNS record.
Function: domain.record.delete
Delete the selected DNS record.
Access level: admin+ user reseller
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the rkey element of domain.record function.
Result: successful operation or error message
Domain record
Function: domain.record.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:
- plid — parent list unique identifier (name element of domain function).
- elid — unique identifier (rkey element of domain.record function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of domain function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of domain function).
- elid — unique identifier (rkey element of domain.record function)
- additional query parameters ...
- Result: successfull operation or error message
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)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of domain function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- owner — Owner. Select a user who will manage this domain name
- name — Domain name. Domain name processed by the name server
- ip_existing — Local IP addresses. List of local IP addresses associated with this domain name
- ip — IP addresses. List of IP addresses associated with this domain name
- ns — Name servers. Enter the name servers
- comment — Comment. Enter detailed description, notes, etc.
- dnssec — . (Optional parameter. To enable the option click "on".) Protect with DNSSEC
- dnssec_turn_off — . (Optional parameter. To enable the option click "on".) Disable DNSSEC protection
Confirm that you want to delete the domain names
Function: domain.delete.request
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)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of domain function)
- additional query parameters ...
- Result: successful operation or error message
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)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of domain function)
- additional query parameters ...
- Result: successful operation or error message
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
- zsk_period — Renewal period. Key update period
DNSBL list
Function: emaildnsbl
Result: the list of elements
List of DNSBL domains
Access level: admin+
- name — DNSBL domain
Editing domain name of the DNSBL list
Function: emaildnsbl.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:
- elid — unique identifier (name element of emaildnsbl function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of emaildnsbl function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name — DNSBL domain. Domain name of the DNSBL list
Delete
Function: emaildnsbl.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 emaildnsbl function.
Result: successful operation or error message
Email limit settings
Function: mailrate.default
Access level: admin+
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- mailrate — Email limit . You can enter the maximum number of emails a user can send, if the "Email limit" is not set for him
Cloudflare
Function: cloudflare.admin_list
Result: the list of elements
Domain names connected to Cloudflare
Access level: admin+
- name — Web domain
- owner — Owner
- type — Connection type
- status — Status
Drill down to User panel
Function: cloudflare.admin_list.su
Drill down to User panel
Access level: admin+
Branding settings
Function: reseller_brand
Access level: reseller
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
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
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
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
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- path — Directory. A directory to save user data. Enter a path relative to the user home directory
DNS settings for managing remote DNSmanager
Function: remote_dns_params
Access level: admin+ reseller
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- remote_url — URL . Enter the URL to access remote DNSmanager
- remote_user — Username. Enter a username to access remote DNSmanager
- remote_password — Password. Enter a user password to access remote DNSmanager
Backup copies
Function: backup2.superlist
Result: the list of elements
Backup copies
Access level: admin+ reseller
- date — Date
- size — Size
- finished — Completed
- duration — Duration (sec)
Name
Function: backup2.superlist.location
Result: the list of elements
Backup location
Access level: admin+ reseller
- nodename — Node name
- size — Size
- usercount — Users
OS installation
Function: backup2.settings
Access level: admin+ 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 (keydate element of backup2.superlist function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (keydate element of backup2.superlist function)
- additional query parameters ...
- Result: successful operation or error message
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
- daily_count — Daily backup copies . Amount of daily 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
User
Function: backup2.superlist.users
Result: the list of elements
Backup copies
Access level: admin+ reseller
- name — User
- owner — Owner
- size — Size
- finished — Completed
- duration — Duration (sec)
- location — Location
Restore user data
Function: backup2.superlist.users.restore2
Restore user data
Access level: admin+ reseller
Parameters:
- 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 ).
Result: successful operation or error message
Delete
Function: backup2.superlist.users.delete
Delete
Access level: admin+ reseller
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the kname element of backup2.superlist.users function.
Result: successful operation or error message
Set filter.
backup2.superlist.users.filter
User recovery
Function: backup2.superlist.users.restoreas
Access level: admin+ 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 (keydate element of backup2.superlist function).
- elid — unique identifier (kname element of backup2.superlist.users function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (keydate element of backup2.superlist function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (keydate element of backup2.superlist function).
- elid — unique identifier (kname element of backup2.superlist.users function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- namesource — Username . Select a user to restore data from the backup copy
- newname — New username . New username that will be created for data recovery from the backup copy
- password — Backup copy password . The password that was used during the backup process
Enter password
Function: backup2.superlist.download
Access level: admin+ 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 (keydate element of backup2.superlist function).
- elid — unique identifier (kname element of backup2.superlist.users function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (keydate element of backup2.superlist function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (keydate element of backup2.superlist function).
- elid — unique identifier (kname element of backup2.superlist.users function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- password — Password. The password that was used during the backup process
Name
Function: backup2.superlist.roots
Result: the list of elements
Saved data
Access level: admin+ reseller
- name — Name
- time — Time
- size -
- undo_time — Restore time
- undo_type -
Roll back changes in the files
Function: backup2.superlist.roots.undo
Roll back changes in the files
Access level: admin+ reseller
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the kname element of backup2.superlist.roots function.
Result: successful operation or error message
Download the selected file or folder.
Function: backup2.superlist.roots.download
Download the selected file or folder.
Access level: admin+ reseller
Restore the selected data
Function: backup2.superlist.roots.restore
Restore the selected data
Access level: admin+ reseller
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the kname element of backup2.superlist.roots function.
Result: successful operation or error message
Drill down to User panel
Function: backup2.superlist.users.su
Drill down to User panel
Access level: admin+ reseller
Delete
Function: backup2.superlist.delete
Delete
Access level: admin+ reseller
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the keydate element of backup2.superlist function.
Result: successful operation or error message
Mailboxes
Function: email
Result: the list of elements
Mailboxes
Access level: admin+ user reseller
- name — Name
- owner — Owner
- ipaddr — IP address
- size — Size, MiB
- properties — Info
- forward — Forward to
- note — Comment
Mailbox
Function: email.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 email function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of email function)
- additional query parameters ...
- Result: successful operation or error message
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.
Result: successful operation or error message
Resume
Function: email.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 email function.
Result: successful operation or error message
Go to the panel with permissions of the mailbox owner
Function: su
Go to the panel with permissions of the mailbox owner
Access level: admin+ user reseller
Mail settings
Function: email.setting
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 email function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of email function)
- additional query parameters ...
- Result: successful operation or error message
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.
Result: successful operation or error message
Filter by owner
Function: email.happyfilter
Filter by owner
Access level: reseller+
Webmail client
Function: email.web
Webmail client
Access level: admin+ user reseller
Set filter.
email.filter
Suspend
Function: email.suspend
Suspend
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.
Result: successful operation or error message
Auto-responder
Function: email.responder
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 email function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of email function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- arfrom — From. Enter the e-mail address that will be used as a sender e-mail address in the auto-responder message, for example, foo@bar.com.
- arsubj — Subject . Enter the subject of the autoresponder message.
- arbody — Message. Enter your auto-responder message. If you leave this fiels blank the autoresponder will be turned off.
- arattach — Attach file. You can add an attachment to the autoresponder message. Enter the path to the attachment relative to your home directory.
- arenable — . (Optional parameter. To enable the option click "on".) Check the box to enable the autoresponder.
Execute command
Function: run
Access level: super user
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- command — Command. Enter command(s) that will start in the server OS
- path — Directory . Select a directory where the command will start
Mail domains
Function: emaildomain
Result: the list of elements
Mail domains
Access level: admin+ user reseller
- name — Name
- defaction — Default action
- owner — Owner
- ipaddr — IP address
- properties — Properties
- comment — Comment
Resume
Function: emaildomain.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 emaildomain function.
Result: successful operation or error message
Drill down to User panel
Function: emaildomain.su
Drill down to User panel
Access level: admin+ user reseller
Delete
Function: emaildomain.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 emaildomain function.
Result: successful operation or error message
Suspend
Function: emaildomain.suspend
Suspend
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 emaildomain function.
Result: successful operation or error message
Mail domain
Function: emaildomain.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 emaildomain function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of emaildomain function)
- additional query parameters ...
- Result: successful operation or error message
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
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- buy_url — URL to buy voucher. Follow this URL to buy a voucher
- api — URL to access API. Use test access to API
Administrators
Function: admin
Result: the list of elements
Administrators
Access level: admin+
- name — Login
- fullname — Full name
- status — Status
- comment — Comment
Delete
Function: admin.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 admin function.
Result: successful operation or error message
Administrator
Function: admin.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:
- elid — unique identifier (name element of admin function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of admin function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name — Login . Enter the username to access the control panel and shell (for superusers)
- 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
- passwd — . Enter a new 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 . Date ans time when the user was created. It cannot be modified and is shown only for information.
- comment — Comment. Enter detailed description, notes, etc.
Suspend
Function: admin.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 admin function.
Result: successful operation or error message
Set filter.
admin.filter
User permissions
Function: userrights
Result: the list of elements
Privileges
Access level: admin+
- caption — Name
- access — User role
Restrict access to list elements
Function: userrights.filter
Restrict access to list elements
Access level: admin+
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.
Result: successful operation or error message
Name
Function: userrights.fields
Result: the list of elements
List of fields (columns)
Access level: admin+
- caption — Name
- access — User role
Resume
Function: userrights.fields.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.fields function.
Result: successful operation or error message
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.
Result: successful operation or error message
Suspend
Function: userrights.fields.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 userrights.fields function.
Result: successful operation or error message
Field privileges
Function: userrights.fields.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 userrights function).
- elid — unique identifier (name element of userrights.fields function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of userrights function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of userrights function).
- elid — unique identifier (name element of userrights.fields function)
- additional query parameters ...
- Result: successfull operation or error message
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)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of admin function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of admin function).
- elid — unique identifier (name element of userrights function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- inhereted — . (Optional parameter. To enable the option click "on".) Do not set permissions. The will be based on other billing policies
- access — User role . Set access permissions to this function
- inherit — . (Optional parameter. To enable the option click "on".) Apply the access permissions to all of the group functions
Policy
Function: userrights.policy
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)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of admin function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of admin function).
- elid — unique identifier (name element of userrights function)
- additional query parameters ...
- Result: successfull operation or error message
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.
Result: successful operation or error message
Suspend
Function: userrights.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 userrights function.
Result: successful operation or error message
Resume
Function: admin.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 admin function.
Result: successful operation or error message
External name servers
Function: domain.slave
Result: the list of elements
External name servers
Access level: admin+
- name — Control panel URL
- username — User
- status — Status
- comment -
Delete the selected external name servers
Function: domain.slave.delete
Delete the selected external name servers
Access level: admin+
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the key element of domain.slave function.
Result: successful operation or error message
Slave name server
Function: domain.slave.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:
- elid — unique identifier (key element of domain.slave function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (key element of domain.slave function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name — Control panel URL. Enter the full URL to the control panel you want to use as an external name server. E.g.: https://mydns.com/manager/dnsmgr
- username — User. Enter the username to access the control panel on the remote server
- password — Password. Enter the password to access the external name server
- comment — Comment. Enter detailed description, notes, etc.
Limits
Function: adminstat
Result: the list of elements
Limits
Access level: admin+
- name — Resource name
- usages — Usage
- units — Units of measure
Resource name
Function: adminstat.details
Result: the list of elements
Resource information
Access level: admin+
- uname — Username
- usages — Usage
Limits
Function: userstat
Result: the list of elements
Limits
Access level: admin+
- name — Resource name
- usages — Usage
- units — Units of measure
Resource name
Function: resellerstat.details
Result: the list of elements
Resource information
Access level: admin+
- uname — Username
- usages — Usage
System resources
Function: accounting_stat
Result: report
System resources usage
Access level: admin+
WWW-redirects
Function: webproxy
Result: the list of elements
WWW-redirects
Access level: admin+
- nodename — Node
- name — Name
- target_ip — Target IP address
- prop — Parameters
- rttl — Expiration date
Delete
Function: webproxy.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 webproxy function.
Result: successful operation or error message
WWW-redirect
Function: webproxy.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:
- elid — unique identifier (name element of webproxy function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of webproxy function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- node — Node. Redirect is created on this node
- name — Domain name. Enter a domain name, for which you are creating the redirect
- aliases — Aliases. Aliases of the WWW-domain for which you are adding this redirect
- target_ip — Target IP address. IP address of the WWW server associated with this domain name
- https — . (Optional parameter. To enable the option click "on".) Activate redirect for the HTTPS protocol
- rttl_date — Expiration date. Redirect expiration date and time
- rttl_hour — . hours (0-23)
- rttl_min — . minutes (0-59)
- comment — Comment. Enter detailed description, notes, etc.
Set filter.
webproxy.filter
Firewall
Function: firewall
Result: the list of elements
Firewall rules settings
Access level: admin+
- type — Action
- proto — Protocol
- sourceip — IP address
- dport — Port
- depend — Dependent rules
- status — Status
- comment — Comment
Delete the selected rule and its dependences
Function: firewall.delete
Delete the selected rule and its dependences
Access level: admin+
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the key element of firewall function.
Result: successful operation or error message
List of countries
Function: firewall.countries
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 (key element of firewall function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (key element of firewall function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Edit the selected rule
Function: firewall.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:
- elid — unique identifier (key element of firewall function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (key element of firewall function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- action — Action. Select what you want to do with the packages sent from the IP address specified below
- proto — Protocol. Select a protocol
- port — Port. Enter the port number.
- denyall — . (Optional parameter. To enable the option click "on".) Deny access for all IP addresses, except for the specified
- src_net — Source address (network). Network address format: 8.8.8.0/24
- src_ip — IP address. You can enter a single IP address or a network (8.8.8.0/24)
- deny_ips — Denied IP addresses. Enter IP addresses that cannot access this network
- allow_ips — Allowed IP addresses. Enter IP addresses that can access this network
- comment — Comment. Enter detailed description, notes, etc.
Backup copies
Function: backups
Result: the list of elements
Backup copies
Access level: admin+ user
- plan — Backup plan
- plan_type — Plan type
- date — Date
- size — Size, MiB
- storage — Storage
- backup_type — Copy type
Create a full backup copy
Function: backups.new
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:
- elid — unique identifier (id element of backups function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (id element of backups function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- storage — Storage. Select a storage
Download the archive containing the backup copy
Function: backups.download
Download the archive containing the backup copy
Access level: admin+ user
Restore
Function: backups.restore
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:
- elid — unique identifier (id element of backups function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (id element of backups function)
- additional query parameters ...
- Result: successful operation or error message
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.
Backup archives
Function: backupdata
Result: the list of elements
Saved data
Access level: admin+ user
- type — Data type
Data name
Function: backupdata.names
Result: the list of elements
Data included into backup copy
Access level: admin+ user
- owner — Owner
Upload the backup copy
Function: backups.upload
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:
- elid — unique identifier (id element of backups function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (id element of backups function)
- additional query parameters ...
- Result: successful operation or error message
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.
- url — URL. Enter the URL to the file that you want to upload. For example, http://example.com/dir/file.html .
- name — File name. Enter the name of the file you want to upload. If you leave this field blank, the file name will be extracted from the URL.
- storage — Storage. Select a storage for the backup copy
Delete the backup copy
Function: backups.delete
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:
- elid — unique identifier (id element of backups function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (id element of backups function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- clean_storages — . (Optional parameter. To enable the option click "on".) Select if you want to delete archives and listings from the storages
Active connections
Function: netactconn
Result: the list of elements
Active network connections
Access level: admin+
- appname — Process name
- count — Number of connections
Backup copies
Function: backup2.list
Result: the list of elements
Backup archives
Access level: user
- name — Date
- size — Size
- finished — Completed
Enter password
Function: backup2.list.download
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 (date element of backup2.list function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (date element of backup2.list function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- password — Password. The password that was used during the backup process
Delete the backup copy from the custom storage
Function: backup2.list.delete
Delete the backup copy from the custom storage
Access level: user
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the date element of backup2.list function.
Result: successful operation or error message
Type
Function: backup2.list.type
Result: the list of elements
Backup archive
Access level: user
- name — Type
Name
Function: backup2.list.files
Result: the list of elements
Backup copies
Access level: user
- name — Name
- time — Change date
- size — Size
Enter password
Function: backup2.list.type.download
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:
- plid — parent list unique identifier (id element of backup2.list.type function).
- elid — unique identifier (kname element of backup2.list.files function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of backup2.list.type function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of backup2.list.type function).
- elid — unique identifier (kname element of backup2.list.files function)
- additional query parameters ...
- Result: successfull operation or error message
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.
Result: successful operation or error message
Name
Function: backup2.list.db
Result: the list of elements
Backup copies
Access level: user
- name — Name
- db_type — Database type
- size — Size
Restore the selected database.
Function: backup2.list.db.restore
Restore the selected database.
Access level: user
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the elname element of backup2.list.db function.
Result: successful operation or error message
Name
Function: backup2.list.email
Result: the list of elements
Backup copies
Access level: user
- name — Name
Restore the selected mailbox.
Function: backup2.list.email.restore
Restore the selected mailbox.
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.email function.
Result: successful operation or error message
Shell-client
Function: shell
Access level: admin+
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
SSL certificates
Function: sslcert
Result: the list of elements
SSL certificates
Access level: admin+ user reseller
- state — In use
- name — SSL certificate name
- owner — Owner
- valid_after — Expiration date
- type — Type
Add SSL certificate.
Function: sslcert.add
Add SSL certificate.
Access level: admin+ user reseller
CSR name
Function: sslcert.csr
Result: the list of elements
Certificate Signing Request (CSR)
Access level: admin+ user reseller
- name — CSR name
- owner — Owner
CSR
Function: sslcert.csr.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:
- plid — parent list unique identifier (key element of sslcert function).
- elid — unique identifier (name element of sslcert.csr function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (key element of sslcert function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (key element of sslcert function).
- elid — unique identifier (name element of sslcert.csr function)
- additional query parameters ...
- Result: successfull operation or error message
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)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (key element of sslcert function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (key element of sslcert function).
- elid — unique identifier (name element of sslcert.csr function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- username — Username. Enter a username this certificate will be created for
- csrname — Name of the CSR . Name of the CSR used in the control panel
- crtname — Certificate name. Enter the name for the certificate
- save_req — . (Optional parameter. To enable the option click "on".) Do not delete the CSR request after confirmation
- crt — Certificate. SSL certificate in the PEM format issued by the Certification Authority
- cacrt — Certificate chain. Chain of SSL-certificates in the PEM-format issued by Certification Authority
Delete the selected CSR.
Function: sslcert.csr.delete
Delete the selected CSR.
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 sslcert.csr function.
Result: successful operation or error message
Let’s Encrypt
Function: letsencrypt.generate
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)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (key element of sslcert function)
- additional query parameters ...
- Result: successful operation or error message
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 generate 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)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (key element of sslcert function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- ssl_cert — SSL certificate . Select an SSL certificate to replace the current certificate
Information
Function: sslcert.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 (key element of sslcert function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (key element of sslcert function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- crt — Certificate:. Domain certificate in the PEM format
- key — Certificate key:. Enter the certificate key in the PEM format
- cacrt — Certificate chain:. Certificate chain in the PEM format
Set filter.
sslcert.filter
Filter by owner
Function: sslcert.happyfilter
Filter by owner
Access level: reseller+
Delete the selected SSL certificate.
Function: sslcert.delete
Delete the selected SSL certificate.
Access level: admin+ user reseller
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the key element of sslcert function.
Result: successful operation or error message
Renew SSL certificate
Function: sslcert.prolong
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)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (key element of sslcert function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- crt — Certificate. SSL certificate in the PEM format issued by the Certification Authority
- cacrt — SSL-certificate chain. SSL-certificate chain in the PEM format
Name
Function: letsencrypt.logs
Result: the list of elements
Operation log
Access level: admin+ user reseller
- date — Date
- status — Status
- message — Event
- description — Additional description
Back to the previous list
Function: sslcrt
Back to the previous list
Access level: admin+ user reseller
Blacklist
Function: blacklist
Result: the list of elements
Blacklist
Access level: admin+
- name — Sender
Delete the blacklist rule
Function: blacklist.delete
Delete the blacklist rule
Access level: admin+
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of blacklist function.
Result: successful operation or error message
Blacklist rule
Function: blacklist.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:
- elid — unique identifier (name element of blacklist function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of blacklist function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name — Sender. Enter sender's email
FTP users
Function: ftp.user
Result: the list of elements
FTP users
Access level: admin+ user reseller
- name — Name
- owner — Owner
- node — Current location
- home — Home directory
- status — Status
- comment — Comment
Resume
Function: ftp.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 ftp.user function.
Result: successful operation or error message
Filter by owner
Function: ftp.user.happyfilter
Filter by owner
Access level: reseller+
Drill down to User panel
Function: ftp.user.su
Drill down to User panel
Access level: admin+ user reseller
FTP-client settings
Function: ftp.user.settings
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 ftp.user function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of ftp.user function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- account — FTP username.
- server — FTP server address .
- port — FTP server port .
FTP user
Function: ftp.user.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 ftp.user function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of ftp.user function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name — Name. Enter the username to access the FTP-server
- owner — Owner. Select the owner of this FTP-user
- passwd — . Enter the password that must be used to access this FTP account.
- confirm — Re-enter password. Re-enter the password to ensure it's correct.
- home — Home directory. Home directory of the FTP-user
- comment — Comment. Enter detailed description, notes, etc.
Suspend
Function: ftp.user.suspend
Suspend
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 ftp.user function.
Result: successful operation or error message
Delete
Function: ftp.user.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 ftp.user function.
Result: successful operation or error message
Set filter.
ftp.user.filter
Slave servers
Function: slaveserver
Result: the list of elements
Slave name servers
Access level: admin+
- url — Control panel URL
- username — User
Slave name server
Function: slaveserver.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:
- elid — unique identifier (name element of slaveserver function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of slaveserver function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- url — Control panel URL. Enter the full URL to the DNSmanager control panel on the slave server. E.g. https://mydns.com:1500/dnsmgr
- username — User. Enter a username to access the control panel on the slave server
- password — Password. Enter a password to access the control panel on the slave server
- sync — . (Optional parameter. To enable the option click "on".) Create the existing domain names on the slave server
Delete the selected slave name servers
Function: slaveserver.delete
Delete the selected slave name servers
Access level: admin+
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of slaveserver function.
Result: successful operation or error message
Auto-responder
Function: email.responder
Access level: 9
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- arfrom — From. Enter the e-mail address that will be used as a sender e-mail address in the auto-responder message, for example, foo@bar.com.
- arsubj — Subject . Enter the subject of the autoresponder message.
- arbody — Message. Enter your auto-responder message. If you leave this fiels blank the autoresponder will be turned off.
- arattach — Attach file. You can add an attachment to the autoresponder message. Enter the path to the attachment relative to your home directory.
- arenable — . (Optional parameter. To enable the option click "on".) Check the box to enable the autoresponder.
Modules
Function: plugin
Access level: admin+
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Video tutorials
Function: video_tutorials
Access level: admin+
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Reserved names
Function: domain.blacklist
Result: the list of elements
Forbidden domains management
Access level: admin+
- name — Domain name
Rename
Function: domain.blacklist.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:
- elid — unique identifier (name element of domain.blacklist function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of domain.blacklist function)
- additional query parameters ...
- Result: successful operation or error message
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.
Result: successful operation or error message
IP addresses
Function: ipaddrlist
Result: the list of elements
IP addresses
Access level: admin+
- name — IP address
Delete the selected IP addresses
Function: ipaddrlist.delete
Delete 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 name element of ipaddrlist function.
Result: successful operation or error message
New IP address
Function: ipaddrlist.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:
- elid — unique identifier (name element of ipaddrlist function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of ipaddrlist function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name — IP address . Enter an IP address that will be assigned to the network interface
Server reboot
Function: reboot_confirm
Access level: super
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Database servers
Function: db.server
Result: the list of elements
Database servers
Access level: reseller
- name — Name
- node — Current location
- type — Type
- host — Server IP address
Delete
Function: db.server.delete
Delete
Access level: reseller
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the key element of db.server function.
Result: successful operation or error message
Set filter.
db.server.filter
Storages
Function: backup.storages
Result: the list of elements
Storages
Access level: admin+ user
- name — Name
- destination — Location
- type — Type
Edit storage
Function: backup.storages.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:
- elid — unique identifier (id element of backup.storages function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (id element of backup.storages function)
- additional query parameters ...
- Result: successful operation or error message
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.
Result: successful operation or error message
Python extensions
Function: pythonext
Result: the list of elements
Python extensions
Access level: admin+
- name — Name
- properties — Properties
Delete extension
Function: pythonext.uninstall
Delete extension
Access level: admin+
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of pythonext function.
Result: successful operation or error message
Install extension
Function: pythonext.install
Install extension
Access level: admin+
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of pythonext function.
Result: successful operation or error message
Set filter.
pythonext.filter
Data import
Function: datapass
Result: the list of elements
Data import queue
Access level: admin+
- begin — Registration date
- hint — Notes
- old_owner — Current owner
- new_owner — New owner
- types — Data type
Set filter.
datapass.filter
Name
Function: datapass.actions
Result: the list of elements
Data import queue tasks
Access level: admin+
- order — Queue
- objtype — Type
- objrepr — Name
- descr — Description
- status — Status
- trys — Attempts
- state — Status
Name
Function: datapass.actions.trys
Result: the list of elements
Data import attempts
Access level: admin+
- try_num — Number
- descr — Description
- begin_time — Start time
- end_time — End time
- state — Status
- error — Error
Cancel data import
Function: datapass.cancel
Cancel data import
Access level: admin+
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of datapass function.
Result: successful operation or error message
Web-disk configuration
Function: webdisk
Access level: admin+
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
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.
Virusdie
Function: virusdie.userreports
Result: the list of elements
Anti-virus scanning reports (Virusdie)
Access level: user
- started — Start date
- duration — Duration
- files — Checked files
- threats — Threats
- curable — Can be disinfected
- treated — Cured
- errors — Errors
- status — Status
Anti-virus scanning parameters (Virusdie)
Function: virusdie.usersettings
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 (id element of virusdie.userreports function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (id element of virusdie.userreports function)
- additional query parameters ...
- Result: successful operation or error message
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
Name
Function: virusdie.userexcludes
Result: the list of elements
Excluded files
Access level: user
- filename — File/directory name
Edit
Function: virusdie.userexcludes.edit
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:
- plid — parent list unique identifier (id element of virusdie.userreports function).
- elid — unique identifier (id element of virusdie.userexcludes function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of virusdie.userreports function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of virusdie.userreports function).
- elid — unique identifier (id element of virusdie.userexcludes function)
- additional query parameters ...
- Result: successfull operation or error message
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.
Result: successful operation or error message
Delete
Function: virusdie.userreports.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.userreports function.
Result: successful operation or error message
Name
Function: virusdie.blacklist
Result: the list of elements
Black list of web domains
Access level: user
- name — Name
- owner — Owner
- status — Status
- blacklisted — Blacklists
- scanned_time — Scanning
Black list databases
Function: virusdie.blacklist.databases
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:
- plid — parent list unique identifier (id element of virusdie.userreports function).
- elid — unique identifier (id element of virusdie.blacklist function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of virusdie.userreports function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of virusdie.userreports function).
- elid — unique identifier (id element of virusdie.blacklist function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- bl_databases — Databases . Black list databases where domain is located
Name
Function: virusdie.blacklist.pages
Result: the list of elements
Infected pages
Access level: user
- url — Page address
- threat_name — Threat name
- suspicious — Potential virus
It opens detailed information about threat
Function: virusdie.blacklist.pages.show_threat
It opens detailed information about threat
Access level: user
Open this file in the File manager
Function: virusdie.blacklist.pages.gofile
Open this file in the File manager
Access level: super user
Signatures
Function: virusdie.signatures
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 (id element of virusdie.userreports function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (id element of virusdie.userreports function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Check files for viruses right now
Function: virusdie.userrun
Check files for viruses right now
Access level: user
Group name
Function: virusdie.userreports.details
Result: the list of elements
Report details
Access level: user
- name — Group name
- type — Group type
- threats — Threats
Name
Function: virusdie.userreports.threatlist
Result: the list of elements
Threads
Access level: user
- filename — File name
- threatid — Thread ID
- threatname — Threat name
- curestate — Result
- status — Status
Navigate to the threat description at Virusdie website
Function: virusdie.userreports.threatlist.show_threat
Navigate to the threat description at Virusdie website
Access level: user
Send file signature to Virusdie
Function: virusdie.userreports.threatlist.sign_redirect
Send file signature to Virusdie
Access level: user
Exclude this file from anti-virus scanning
Function: virusdie.userreports.threatlist.exclude
Exclude this file from anti-virus scanning
Access level: user
Delete the infected file
Function: virusdie.userreports.threatlist.delete
Delete the infected file
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.
Result: successful operation or error message
Open this file in the File manager
Function: virusdie.userreports.threatlist.gofile
Open this file in the File manager
Access level: super user
Infected part of the code
Function: virusdie.userreports.threatlist.showcode
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:
- plid — parent list unique identifier (id element of virusdie.userreports.details function).
- elid — unique identifier (id element of virusdie.userreports.threatlist function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of virusdie.userreports.details function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (id element of virusdie.userreports.details function).
- elid — unique identifier (id element of virusdie.userreports.threatlist function)
- additional query parameters ...
- Result: successfull operation or error message
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.
Result: successful operation or error message
Disinfect the selected file
Function: virusdie.userreports.threatlist.cure
Disinfect the selected file
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.
Result: successful operation or error message
Set filter.
virusdie.userreports.threatlist.filter
LVE load
Function: lve_stat_load
Result: report
User with maximum LVE load
Access level: admin+
Limits
Function: resellerstat
Result: the list of elements
Limits
Access level: reseller
- name — Resource name
- usages — Usage
- units — Units of measure
File manager
Function: file
Result: the list of elements
File manager
Access level: user super
MySQL installation
Function: docker_mysql
Result: the list of elements
MySQL installation
Access level: super
- name — MySQL version
- props — Status
Edit
Function: docker_mysql.edit
Edit
Access level: super
Function: docker_mysql.details
Access level: super
Install chosene MySQL version
Function: docker_mysql.install
Install chosene MySQL version
Access level: super
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the key element of docker_mysql function.
Result: successful operation or error message
Delete chosen MySQL version
Function: docker_mysql.uninstall
Delete chosen MySQL version
Access level: super
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the key element of docker_mysql function.
Result: successful operation or error message
IP addresses
Function: ipaddr
Result: the list of elements
IP addresses
Access level: admin+ user reseller
- name — IP address
- node — Server
- iprole — Role
- owner — Owner
- domain — Default WWW-domain
- state — Properties
- comment — Comment
Settings KernelCare
Function: kernelcare.settings
Access level: super
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Virusdie
Function: virusdie
Result: the list of elements
Virusdie
Access level: admin+
- name — Username
- active_threats — Active threads
- repcount — All reports
- maxreports — Save reports
- status — Status
- blacklisted — Blacklisted
Run anti-virus scanning
Function: virusdie.group.userrun
Run anti-virus scanning
Access level: admin+
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of virusdie function.
Result: successful operation or error message
Suspend
Function: virusdie.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 virusdie function.
Result: successful operation or error message
Resume
Function: virusdie.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 virusdie function.
Result: successful operation or error message
Set filter.
virusdie.filter
Filter by owner
Function: virusdie.happyfilter
Filter by owner
Access level: admin+
Cloudflare
Function: cloudflare
Result: the list of elements
Cloudflare
Access level: user
- name — Web domain
- type — Connection type
- sub — Subscription
- status — Status
Statistics
Function: cloudflare.stat
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)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of cloudflare function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- period — Period . Select period for statistics
- request_count — Requests . Number of processed requests
- cached_traffic — Cached traffic . Cached traffic for the selected period
- threats — Threads . Blocked threats
Settings
Function: cloudflare.zone_settings
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)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of cloudflare function)
- additional query parameters ...
- Result: successful operation or error message
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)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of cloudflare function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- email — Mailbox. Enter the mailbox of Cloudflare user
- password — Password. Enter the password of Cloudflare user
Update information about your domains in Cloudflare
Function: cloudflare.refresh
Update information about your domains in Cloudflare
Access level: user
Delete the selected zone from Cloudflare
Function: cloudflare.delete
Delete the selected zone from Cloudflare
Access level: user
Clear cache
Function: cloudflare.clear_cache
Clear cache
Access level: user
Name
Function: cloudflare.log
Result: the list of elements
Action log
Access level: user
- date — Date
- event — Action
- status — Result
- details — Details
Name
Function: cloudflare.records
Result: the list of elements
Zone records
Access level: user
- name — Name
- ttl — TTL, sec
- rtype — Type
- value — Value
- info — Additional information
Update information about records
Function: cloudflare.records.refresh
Update information about records
Access level: user
Delete the selected DNS record.
Function: cloudflare.records.delete
Delete the selected DNS record.
Access level: user
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the rkey element of cloudflare.records function.
Result: successful operation or error message
Domain record
Function: cloudflare.records.edit
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:
- plid — parent list unique identifier (name element of cloudflare function).
- elid — unique identifier (rkey element of cloudflare.records function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of cloudflare function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of cloudflare function).
- elid — unique identifier (rkey element of cloudflare.records function)
- additional query parameters ...
- Result: successfull operation or error message
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)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of cloudflare function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- name — Web domain. Select a web-domain you want to connect to Cloudflare
- type — Connection type . Select a connection type
- cname — CNAME. Enter a canonical name that refers to IP address of your domains which Cloudflare will use
- aliases — Aliases . Enter aliases that Cloudflare will proxy
Name
Function: cloudflare.firewall
Result: the list of elements
Access rules
Access level: user
- mode — Action
- value — Sources address
- note — Comment
Update information about access rules
Function: cloudflare.firewall.refresh
Update information about access rules
Access level: user
Delete
Function: cloudflare.firewall.delete
Delete
Access level: user
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the rule_id element of cloudflare.firewall function.
Result: successful operation or error message
Create access rule
Function: cloudflare.firewall.edit
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:
- plid — parent list unique identifier (name element of cloudflare function).
- elid — unique identifier (rule_id element of cloudflare.firewall function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of cloudflare function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of cloudflare function).
- elid — unique identifier (rule_id element of cloudflare.firewall function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- target — Source . Type of the source that the rule is created for
- value_country — Source address. Source (country code)
- value_ip — Source address. Source IP (IP address or IP range)
- mode — Action . Select an action
- note — Comment. Additional information about access rule
Name
Function: cloudflare.pages
Result: the list of elements
Rules for zone pages
Access level: user
- url — Page address
- status — Status
Suspend
Function: cloudflare.pages.suspend
Suspend
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.
Result: successful operation or error message
Resume
Function: cloudflare.pages.resume
Resume
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.
Result: successful operation or error message
Update the rules
Function: cloudflare.pages.refresh
Update the rules
Access level: user
Page rules
Function: cloudflare.pages.edit
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:
- plid — parent list unique identifier (name element of cloudflare function).
- elid — unique identifier (url element of cloudflare.pages function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of cloudflare function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of cloudflare function).
- elid — unique identifier (url element of cloudflare.pages function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- url — URL . Enter the page URL that you want to create a rule for
- priority — Rule priority . Rules priority allows to specify how they will be processed
- custom_priority — After . This rule will be executed after the selected one
- status — Status. Allows to define is the rule is active or not
- always_use_https — . (Optional parameter. To enable the option click "on".) Always redirect to HTTPS
- enable_forward — . (Optional parameter. To enable the option click "on".) Enable redirect to a certain URL
- forward_url — Destination IP . Enter the URL for forwarding
- forward_type — Return code . Enter the code that will be returned
- always_online — . (Optional parameter. To enable the option click "on".) If the page is not accessible, it will run from CDN
- automatic_https_rewrites — . (Optional parameter. To enable the option click "on".) Automatic HTTPS rewrites
- browser_cache_ttl — Browser TTL . Browser cache TTL
- 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.
Result: successful operation or error message
System resources
Function: user_acct_stat
Result: report
System resources usage by user
Access level: user
Conflicts
Function: conflict
Result: the list of elements
Conflicts
Access level: admin+
- type — Type
- subtype — Description
- name — Name
- nodelist — Nodes
Resolve conflict
Function: conflict.solve
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 (id element of conflict function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (id element of conflict function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- type — Type. Select a type of the conflicting object
- subtype — Description. Conflict description
- name — Name. Name of the conflicting data element
Set filter.
conflict.filter
WWW-logs
Function: userlogs.users
Result: the list of elements
WWW log
Access level: admin+
- name — Username
- loc — Location
- count — WWW-domains
WWW-log files
Function: userlogs
Result: the list of elements
WWW log
Access level: admin+
- name — File name
- size — File size
- moddate — Change date
- arch — Number of archives
- archsize — Archive total size
Empty the selected log file.
Function: userlogs.delete
Empty the selected log file.
Access level: admin+
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of userlogs function.
Result: successful operation or error message
Download the selected log file.
Function: userlogs.download
Download the selected log file.
Access level: admin+
File name
Function: userlogs.archive
Result: the list of elements
WWW log
Access level: admin+
- name — File name
- size — File size
- moddate — Change date
- arch — Number of archives
- archsize — Archive total size
View user log
Function: userlogs.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 userlogs function).
- elid — unique identifier (name element of userlogs.archive function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of userlogs function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of userlogs function).
- elid — unique identifier (name element of userlogs.archive function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- strcount — Number of rows displayed . Select the number of rows that are shown from the log file.
- cont — Log file:. Show contents of the last log entries
Filter by owner
Function: userlogs.users.happyfilter
Filter by owner
Access level: admin+
Set filter.
userlogs.users.filter
Web-scripts
Function: aps.user_catalog
Access level: user reseller
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Notifications
Function: problems
Result: the list of elements
Notifications
Access level: user reseller
- id — Id
- dateinit — Date
- owner — User
- type — Type
- problem_id — Identifier
- description — Description
- properties — Properties
- dateautosolve — Last attempt
- autosolvecount — Attempts
- sameproblemcount — Number
- period — Period (min)
Notification module settings
Function: problems.settings
Access level: 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 (id element of problems function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (id element of problems function)
- additional query parameters ...
- Result: successful operation or error message
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.
Result: successful operation or error message
Notification properties
Function: problems.edit
Access level: 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 (id element of problems function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (id element of problems function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- id — Id. Notification identifier
- type — Notification type. Notification type
- date_init — Date. Date when this notification appeared in the system for the last time
- description_local — Description. Text description of the notification
- level — Level. Select a notification level: message, warning, fatal error
- 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.
Result: successful operation or error message
Name
Function: problems.log
Result: the list of elements
Log
Access level: user reseller
- date — Date
- owner — User
- duration — Duration
Set filter.
problems.filter
Web-scripts
Function: aps.catalog
Result: the list of elements
Web-scripts
Access level: admin+
- name — Name
- apps_count — Number of packages
- status — Status
Set filter.
aps.catalog.filter
Name
Function: aps.catalog.apps
Result: the list of elements
Web-script packages
Access level: admin+
- name — Name
- version — Version
- specification — Specifications
- description — Description
- status — Status
Web-script
Function: aps.catalog.apps.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 aps.catalog function).
- elid — unique identifier (id element of aps.catalog.apps function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of aps.catalog function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of aps.catalog function).
- elid — unique identifier (id element of aps.catalog.apps function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- name — Name. Name of the web-script
- version — Version. Current version of the Web-script
- release — Release. Web-script build number
- description — Description. Description of the Web-script
Forbid users to use this package
Function: aps.catalog.apps.suspend
Forbid users to use this package
Access level: admin+
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of aps.catalog.apps function.
Result: successful operation or error message
This package will be used by default, if users select "Quick install"
Function: aps.catalog.apps.default
This package will be used by default, if users select "Quick install"
Access level: admin+
Install the selected package
Function: aps.install
Install the selected package
Access level: admin+
Allow users to install this package
Function: aps.catalog.apps.resume
Allow users to install this package
Access level: admin+
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of aps.catalog.apps function.
Result: successful operation or error message
Update directory contents
Function: aps.cache
Update directory contents
Access level: admin+
Templates
Function: preset
Result: the list of elements
User templates
Access level: admin+ reseller
- name — Name
- level — Type
- usage — Usage
- limit_quota — Disk (MiB)
- limit_webdomains — WWW-domains
- limit_domains — Domain names
- limit_db — Databases
- status — Properties
- comment — Comment
Set filter.
preset.filter
Delete
Function: preset.delete
Delete
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 function.
Result: successful operation or error message
Template
Function: preset.edit
Access level: admin+ 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 preset function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of preset function)
- additional query parameters ...
- Result: successful operation or error message
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
Name
Function: preset.allocation
Result: the list of elements
Allocation of template users among cluster nodes
Access level: admin+ reseller
- node — Cluster node
- count — Users
- state — Status
- roles — Roles
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.
Result: successful operation or error message
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.
Result: successful operation or error message
Shell-client
Function: usershell
Access level: user
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Users
Function: user
Result: the list of elements
Users
Access level: admin+ reseller
- status — Status
- name — Login
- fullname — Full name
- owner — Owner
- preset — Template
- quota — Disk, (MiB)
- traff — Traffic (MiB/current month)
- loc — Location
- comment — Comment
User
Function: user.edit
Access level: admin+ 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 user function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of user function)
- additional query parameters ...
- Result: successful operation or error message
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.
Result: successful operation or error message
Delete
Function: user.delete
Delete
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.
Result: successful operation or error message
User location on cluster nodes
Function: user.location
Access level: admin+ 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 user function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of user function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Add
Function: user.add
Add
Access level: admin+ reseller
Resume
Function: user.resume
Resume
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.
Result: successful operation or error message
Bandwith usage
Function: traffic_report
Result: report
Traffic usage
Access level: admin+ user
WWW-log files
Function: userlogs
Result: the list of elements
WWW log
Access level: user
- name — File name
- size — File size
- moddate — Change date
- arch — Number of archives
- archsize — Archive total size
DDoS-GUARD
Function: ddos_guard_view
Result: the list of elements
DDoS-GUARD
Access level: super+
- name — Name
- domain — Web domain
- owner — Owner
- prop — Status
- ipaddr — IP address
- proxy — proxy-IP
Name
Function: ddos_guard_view.accesslist
Result: the list of elements
Access lists
Access level: super+
- id — Id
- ipaddr — IP addresses
- dateadd — Addition date
- type — Type of rule
- reason — Reasons
Rule settings
Function: ddos_guard_view.accesslist.edit
Access level: super+
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 ddos_guard_view function).
- elid — unique identifier (id element of ddos_guard_view.accesslist function)
- Result: object parameters list
Create an object:
Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of ddos_guard_view function).
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- plid — parent list unique identifier (name element of ddos_guard_view function).
- elid — unique identifier (id element of ddos_guard_view.accesslist function)
- additional query parameters ...
- Result: successfull operation or error message
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.
Result: successful operation or error message
Settings
Function: ddos_guard_view.settings
Access level: super+
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 ddos_guard_view function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of ddos_guard_view function)
- additional query parameters ...
- Result: successful operation or error message
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.
Result: successful operation or error message
Adding domain for protection
Function: ddos_guard_view.edit.first
Access level: super+
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 ddos_guard_view function)
- Result: object parameters list
Create an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
Change an object:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- elid — unique identifier (name element of ddos_guard_view function)
- additional query parameters ...
- Result: successful operation or error message
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.
Result: successful operation or error message
Softaculous
Function: softaculous_nodes
Access level: super
The function is simultaneously used to view and change form's data
View data:
- Result: parameters list
Change the data:
- Parameters:
- sok — the parameter must not be empty, generally "ok".
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
Backup archives
Function: backupdata
Result: the list of elements
Saved data
Access level: admin+ user
- type — Data type