From ISPWiki

Legend

- available in ISPmanager Lite - available in ISPmanager Professional - available in ISPmanager Cluster

Contents 1 Server administrator 1.1 Accounts Management 1.1.1 Administrators 1.1.2 Resellers 1.1.3 Users 1.1.4 Mailboxes 1.2 Domains 1.2.1 WWW domains 1.2.2 E-Mail domains 1.2.3 Domain names (DNS) 1.3 Management Tools 1.3.1 Databases 1.3.2 Firewall 1.3.3 Services 1.3.4 SSL certificates 1.3.5 Web-scripts (APS) 1.3.6 Backends 1.4 Maintenance 1.4.1 Backup plan management 1.4.2 User import 1.4.3 Fix disk quotas 1.5 Spam Filter 1.5.1 Dnsbl block lists 1.5.2 Greylisting 1.5.3 Spamassassin 1.5.4 Whitelist 1.5.5 Blacklist 1.5.6 Email limit 1.6 Server Statistics 1.6.1 Usage statistics 1.6.2 System information 1.6.3 System resources 1.6.4 Active connections 1.6.5 Background tasks 1.6.6 Load statistics 1.7 Server Settings 1.7.1 Server parameters 1.7.2 IP-addresses 1.7.3 Anonymous FTP 1.7.4 PHP configuration 1.7.5 PHP extensions 1.7.6 Perl modules 1.7.7 Python modules 1.7.8 Applications 1.7.9 Experimental Features 1.7.10 Plug-ins 1.8 Cluster settings 1.8.1 Roles 1.8.2 Nodes 1.8.3 MySQL failover 1.9 Other Settings 1.9.1 Policy 1.9.2 Presets 1.9.3 DNS settings 1.9.4 Logs rotation 1.9.5 Brand settings 1.9.6 Slave servers 1.9.7 Integration with IPmanager 1.9.8 Favourites 1.9.9 General settings 1.9.10 Control panel URL 1.10 Help 1.10.1 License 1.10.2 Updates 1.10.3 Wish list 1.10.4 Error log

See also

• ISPmanager API/Reseller
• ISPmanager API/Mail user
• ISPmanager API/User (siteadmin)

Server administrator

Accounts Management

Administrators

Function: mgradmin

Result: the list of elements

• name - Login.
• disabled - This account is not active.
• uid0 - This administrator has shell access with root privileges.
• note - Notes:.

Function: mgradmin.edit

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 "mgradmin" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("name" element of "mgradmin" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - User name.
• passwd - Password.
• confirm - Confirm.
• uid0 - Superuser. (Optional parameter. To enable the option click "on".)
• atype - Access.

Possible values :

• • allow - to all functions
  • allow_partial - to specified functions only
  • deny_partial - to all but specified functions

• fname - Function list. (One or more values space-delimited)
• email - E-mail.
• welcome - Send message. (Optional parameter. To enable the option click "on".)

Function: mgradmin.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "mgradmin" function.

Result: successful operation or error message

Function: mgradmin.enable

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "mgradmin" function.

Result: successful operation or error message

Function: mgradmin.disable

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "mgradmin" function.

Result: successful operation or error message

Resellers

Function: reseller

Result: the list of elements

• name - Name.
• slave - Server.
• disabled - This reseller account is not active.
• cgi - CGI is active for the WWW domains of this reseller.
• wsgi - WSGI is active for the WWW domains of this reseller .
• php - PHP is active for for the WWW domains of this reseller.
• ssi - SSI is active for the WWW domains of this reseller.
• ssl - HTTPS is active for for the WWW domains of this reseller.
• shell - Shell access is active for this reseller.
• note - Notes:.
• user - Users. Attributes :
  • used - The used number.
  • limit - Max value limitation
• disk - Disk quota. Attributes :
  • used - The used number.
  • limit - Max value limitation
• bandwidth - Traffic. Attributes :
  • used - The used number.
  • limit - Max value limitation

Function: reseller.edit

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 "reseller" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("name" element of "reseller" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Username.
• passwd - Password.
• confirm - Re-enter password.
• ip - IP-address.
• ip6 - IPv6. The parameter may vary depending on feature ipv6.
• preset - Preset.
• email - E-mail.
• welcome - Send message. (Optional parameter. To enable the option click "on".)
• shell - Shell access. (Optional parameter. To enable the option click "on".)
• ssl - SSL. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature ssl.
• cgi - CGI. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature cgi.
  Active parameter allows the use of the following parameters: 'phpcgi','phpfcgi'

• wsgi - WSGI. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature wsgi.
• phpmod - PHP as Apache module. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature phpmod.
• phpcgi - PHP as CGI. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature phpcgi.
• phpfcgi - PHP as FastCGI. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature phpfcgi.
• ssi - SSI. (Optional parameter. To enable the option click "on".)
• disklimit - Disk quota. (Value. Use "1000000" to represent "infinity") The parameter may vary depending on feature quota.
• userlimit - Users. (Value. Use "10000" to represent "infinity")
• ftplimit - FTP accounts. (Value. Use "10000" to represent "infinity")
• maillimit - Mailboxes. (Value. Use "10000" to represent "infinity")
• domainlimit - Domains. (Value. Use "10000" to represent "infinity") The parameter may vary depending on feature dns.
• webdomainlimit - WWW domains. (Value. Use "10000" to represent "infinity")
• maildomainlimit - E-mail domains. (Value. Use "10000" to represent "infinity")
• baselimit - Databases. (Value. Use "10000" to represent "infinity") The parameter may vary depending on feature db.
• baseuserlimit - Database users. (Value. Use "10000" to represent "infinity") The parameter may vary depending on feature db.
• bandwidthlimit - Traffic. (Value. Use "100000000" to represent "infinity")
• iplimit - IP addresses. (Value. Use "10000" to represent "infinity") The parameter may vary depending on feature ipctrl.
• ip6limit - IPv6 addresses. (Value. Use "10000" to represent "infinity") The parameter may vary depending on feature ipv6.
• cpulimit - CPU limit. (Value. Use "100000" to represent "infinity")
• memlimit - RAM limit. (Value. Use "100000" to represent "infinity")
• proclimit - Process limit. (Value. Use "100000" to represent "infinity")
• mysqlquerieslimit - MySQL queries . (Value. Use "100000000" to represent "infinity") The parameter may vary depending on feature dbhaslimits.
• mysqlupdateslimit - MySQL updates. (Value. Use "100000000" to represent "infinity") The parameter may vary depending on feature dbhaslimits.
• mysqlconnectlimit - MySQL connections. (Value. Use "100000000" to represent "infinity") The parameter may vary depending on feature dbhaslimits.
• mysqluserconnectlimit - Simultaneous connections to MySQL . (Value. Use "100000000" to represent "infinity") The parameter may vary depending on feature dbhasuconnlimits.
• maxclientsvhost - Apache mpm-itk workers. (Value. Use "100000000" to represent "infinity") The parameter may vary depending on feature apache-mpm-itk.
• limitconn - Simultaneous connections per session . (Value. Use "65535" to represent "infinity") The parameter may vary depending on feature nginx.
• mailrate - Email limit . (Value. Use "100000000" to represent "infinity") The parameter may vary depending on feature mailrate.
• note - .

Function: reseller.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "reseller" function.

Result: successful operation or error message

Function: reseller.enable

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "reseller" function.

Result: successful operation or error message

Function: reseller.disable

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "reseller" function.

Result: successful operation or error message

Function: reseller.access

Parameters:

• elid - unique identifier ("name" element of "reseller" function).

Result: elements list

• ftitle - Module name.
• name - Function name.
• disabled - This module is not active for this reseller.

Function: reseller.access.enable

Parameters:

• plid - parent list unique identifier ("name" element of "reseller" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "reseller.access" function.

Result: successful operation or error message

Function: reseller.access.disable

Parameters:

• plid - parent list unique identifier ("name" element of "reseller" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "reseller.access" function.

Result: successful operation or error message

Function: new.msg

• subj - Subject.
• prio - Priority.
• category - Category.
• text - Text.

Users

Function: user

Result: the list of elements

• name - Name.
• slave - Server.
• owner - Owner.
• preset - Preset.
• disabled - This user account and the WWW domains of this user are not active.
• unex - The control panel properties are not specified for this user account .
• cgi - CGi is active for the WWW domains of this user.
• wsgi - WSGI is active for the WWW domains of this user .
• php - PHP is active for the WWW domains of this user.
• ssi - SSI is active for the WWW domains of this user.
• ssl - HTTPS is active for the WWW domains of this user.
• shell - Shell acces is active for this user.
• usermove - Import a user from another server.
• note - Notes:.
• disk - Disk quota. Attributes :
  • used - The used number.
  • limit - Max value limitation
• bandwidth - Bandwidth. Attributes :
  • used - The used number.
  • limit - Max value limitation

Function: user.edit

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • 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 - Username.
• passwd - Password.
• confirm - Re-enter password.
• owner - Owner.
• ip - IP-address.
• ip6 - IPv6. The parameter may vary depending on feature ipv6.
• domain - Domain.
• preset - Preset.
• email - E-mail.
• welcome - Send message. (Optional parameter. To enable the option click "on".)
• shell - Shell access. (Optional parameter. To enable the option click "on".)
• ssl - SSL. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature ssl.
• cgi - CGI. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature cgi.
  Active parameter allows the use of the following parameters: 'phpcgi','phpfcgi'

• wsgi - WSGI. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature wsgi.
• ssi - SSI. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature ssi.
• phpmod - PHP as an Apache module. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature phpmod.
• phpcgi - PHP as CGI. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature phpcgi.
• phpfcgi - PHP as FastCGI. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature phpfcgi.
• safemode - PHP safe_mode. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature phpmod.
• disklimit - Disk quota. The parameter may vary depending on feature quota.
• ftplimit - FTP accounts. (Value. Use "10000" to represent "infinity") The parameter may vary depending on feature ftp.
• maillimit - Mailboxes. (Value. Use "10000" to represent "infinity") The parameter may vary depending on feature email.
• domainlimit - Domains. (Value. Use "10000" to represent "infinity") The parameter may vary depending on feature dns.
• webdomainlimit - WWW domains. (Value. Use "10000" to represent "infinity") The parameter may vary depending on feature www.
• maildomainlimit - E-mail domains. (Value. Use "10000" to represent "infinity") The parameter may vary depending on feature email.
• baselimit - Databases. (Value. Use "10000" to represent "infinity") The parameter may vary depending on feature db.
• baseuserlimit - Database users. (Value. Use "10000" to represent "infinity") The parameter may vary depending on feature db.
• bandwidthlimit - Traffic. (Value. Use "100000000" to represent "infinity")
• cpulimit - CPU limit. (Value. Use "100000" to represent "infinity")
• memlimit - Memory limit. (Value. Use "100000" to represent "infinity")
• proclimit - Process limit. (Value. Use "100000" to represent "infinity")
• mysqlquerieslimit - Requests to MySQL. (Value. Use "100000000" to represent "infinity") The parameter may vary depending on feature dbhaslimits.
• mysqlupdateslimit - MySQL updates . (Value. Use "100000000" to represent "infinity") The parameter may vary depending on feature dbhaslimits.
• mysqlconnectlimit - Connections to MySQL. (Value. Use "100000000" to represent "infinity") The parameter may vary depending on feature dbhaslimits.
• mysqluserconnectlimit - Simultaneous connections to MySQL . (Value. Use "100000000" to represent "infinity") The parameter may vary depending on feature dbhasuconnlimits.
• maxclientsvhost - Apache mpm-itk workers. (Value. Use "100000000" to represent "infinity") The parameter may vary depending on feature apache-mpm-itk.
• limitconn - Simultaneous connections per session . (Value. Use "65535" to represent "infinity") The parameter may vary depending on feature nginx.
• mailrate - Email limit . (Value. Use "100000000" to represent "infinity") The parameter may vary depending on feature mailrate.
• note - .

Function: user.delete

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

Function: user.enable

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

Function: user.disable

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

Function: iplist

Parameters:

• elid - unique identifier ("name" element of "user" function).

Result: elements list

• name - IP-address.
• count - Number of WWW domains.
• domain - Default WWW domain.
• rname - Reverse domain name.

Function: iplist.edit

The function is simultaneously used to view and change object's parameters.

View objects parameters:

• Parameters:
  • plid - parent list unique identifier ("name" element of "user" function).
  • elid - unique identifier ("name" element of "iplist" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("name" element of "user" function).
  • elid - unique identifier ("name" element of "iplist" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• type - Type of IP-address .
  If the custom value is selected the parameters are allowed to use: 'name'

• name - IP-address.
• stat - Status.

Possible values :

• • free - Free
  • shared - Shared
  • assigned - Assigned

• owner - Owner.
• domain - Default domain. The parameter may vary depending on feature www.
• rname - Reverse domain name. The parameter may vary depending on feature ipmgr.

Function: user.access

Parameters:

• elid - unique identifier ("name" element of "user" function).

Result: elements list

• ftitle - Module name.
• name - Module name.
• disabled - This module is not active for this user.

Function: user.access.enable

Parameters:

• plid - parent list unique identifier ("name" element of "user" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "user.access" function.

Result: successful operation or error message

Function: user.access.disable

Parameters:

• plid - parent list unique identifier ("name" element of "user" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "user.access" function.

Result: successful operation or error message

Function: usersystemresources

Parameters:

• elid - unique identifier ("name" element of "user" function).

Result: elements list

• time - Date.
• memory - Memory (GB).
• utime - CPU user time (sec) .
• stime - CPU system time (sec) .
• etime - Uptime (minutes).
• io - I/O operations.
• mysqltime - MySQL time .
• mysqlrequests - Number of MySQL requests .

Function: usersystemresources.edit

• period - Period.

Function: new.msg

• subj - Subject.
• prio - Priority.
• category - Category.
• text - Text.

Function: backuponeclick

• destdir - Backup directory .

Function: user.setfilter

Mailboxes

Function: email

Result: the list of elements

• name - Name.
• pop3 - POP3 login.
• disabled - This mailbox is not active.
• vacation - Auto-responder is active for this mailbox..
• forward - Mail forwarding is active for this mailbox.
• antispam_disabled - Anti-spam is not active .
• greylist_disabled - Greylisting is disabled .
• note - Notes:.
• size - Size. Attributes :
  • used - The used number.
  • limit - Max value limitation

Function: email.edit

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • 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.
• domain - Domain.
• aliases - Alias(es). (One or more values space-delimited)
• passwd - Password.
• confirm - Re-enter password.
• quota - Size.
• forward - Send a copy to. (One or more values space-delimited)
• rmlocal - Don't save incoming e-mails. (Optional parameter. To enable the option click "on".)
• greylist - Enable greylist. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature greylist.
• spamassassin - Enable SpamAssassin. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature sa.
• mailrate - Email limit . (Value. Use "100000000" to represent "infinity") The parameter may vary depending on feature mailrate.
• spamass_u_l - User's SpamAssassin. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature usersa.
  Active parameter allows the use of the following parameters: 'required_score','rewrite_subject','report_safe','spam_action'

• required_score - Spam score . The parameter may vary depending on feature usersa.
• rewrite_subject - Enter into the Theme filed. The parameter may vary depending on feature usersa.
• report_safe - Report type . The parameter may vary depending on feature usersa.
• spam_action - Action . The parameter may vary depending on feature usersa.
• note - .

Function: email.vacation

The function is simultaneously used to view and change object's parameters.

View object's parameters:

• Parameters:
  • elid - unique identifier ("name" element of "email" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • 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.
• arsubj - Subject.
• arbody - Мessage.
• arenable - Enable autoresponder. (Optional parameter. To enable the option click "on".)

Function: email.sorter

Parameters:

• elid - unique identifier ("name" element of "email" function).

Result: elements list

• name - Name .

Function: email.sorter.edit

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 "email" function).
  • elid - unique identifier ("name" element of "email.sorter" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("name" element of "email" function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("name" element of "email" function).
  • elid - unique identifier ("name" element of "email.sorter" function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• name - Name.
• pos - Place before .
• cond_param - Parameter .
  If the cond_none value is selected the parameters are denied: 'cond_value'

• cond - Condition .
• cond_value - Value.
• act - Supported action .
  If the command value is selected the parameters are allowed to use: 'act_command','act_copy' and the parameters are denied: 'act_email','act_imap','act_imap_new'

• act_email - Email .
• act_imap - IMAP folder .
  If the new_folder value is selected the parameters are allowed to use: 'act_imap_new'

• act_imap_new - New IMAP folder.
• act_command - Program.
• copy - Use a copy. (Optional parameter. To enable the option click "on".)

Function: email.sorter.delete

Parameters:

• plid - parent list unique identifier ("name" element of "email" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "email.sorter" function.

Result: successful operation or error message

Function: email.sorter.cond

Parameters:

• elid - unique identifier ("name" element of "email.sorter" function).

Result: elements list

• id - The list element unique identifier
• cond_param - Parameter .
• cond - Condition .
• cond_value - Value .

Function: email.sorter.cond.edit

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 "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 "yes".
  • plid - parent list unique identifier ("name" 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 "yes".
  • plid - parent list unique identifier ("name" 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):

• cond_param - Parameter .
• cond - condition.
• cond_value - Value .

Function: email.sorter.cond.delete

Parameters:

• plid - parent list unique identifier ("name" element of "email.sorter" function).
• 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

Function: email.delete

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

Function: email.clear

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

Function: email.enable

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

Function: email.disable

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

Function: email.outlook

The function is simultaneously used to view and change object's parameters.

View object's parameters:

• Parameters:
  • elid - unique identifier ("name" element of "email" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • 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):

Domains

WWW domains

Function: wwwdomain

Result: the list of elements

• name - Name.
• ip - IP-address.
• docroot - Document root.
• disabled - WWW domain is disabled .
• cgi - CGI is active for this WWW domain.
• wsgi - WSGI is active for this WWW domain .
• php - PHP is active for this WWW domain.
• ssi - SSI is active for this WWW domain.
• frp - FrontPage extensions are active for this WWW domain.
• ror - This WWW domain can use Ruby on rails.
• ssl - HTTPS is active for this WWW domain.

Function: wwwdomain.edit

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 "wwwdomain" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("name" element of "wwwdomain" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• domain - Domain name.
• alias - Alias(es). (One or more values space-delimited)
• docroot - Root folder.
• owner - Owner.
• version - Internet protocol version . The parameter may vary depending on feature ipv6.
  If the ipv4 value is selected the parameters are allowed to use: 'ip4' and the parameters are denied: 'ip6'

• ip - IP-address.
• ip6 - IPv6. The parameter may vary depending on feature ipv6.
• pool - Application pool . The parameter may vary depending on feature iis.
• admin - E-mail administrator. The parameter may vary depending on feature webemail.
• charset - Encoding (character set).
• index - Default page. (One or more values space-delimited)
• autosubdomain - Auto subdomains. The parameter may vary depending on feature asd.

Possible values :

• • asdnone - disabled
  • asddir - as separate directory
  • asdsubdir - as WWW domain subdirectory

• php - PHP.

Possible values :

• • phpnone - PHP is not supported
  • phpmod - PHP as an Apache module
  • phpcgi - PHP as CGI
  • phpfcgi - PHP as FastCGI

• cgi - CGI-bin. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature cgi.
  Active parameter allows the use of the following parameters: 'ror'

• wsgi - wsgi-scripts. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature wsgi.
• ssi - SSI. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature ssi.
  Active parameter allows the use of the following parameters: 'ssiext'

• ssiext - SSI file extensions. The parameter may vary depending on feature ssi.
• frp - FrontPage. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature frp.
  Active parameter allows the use of the following parameters: 'fppasswd'

• fppasswd - Password for FrontPage. The parameter may vary depending on feature frp.
• ror - Ruby on rails. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature ror.
  Active parameter denies the following parameters: 'autosubdomain'

• ssl - SSL. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature ssl.
  Active parameter allows the use of the following parameters: 'sslport','cert'

• sslport - SSL port. The parameter may vary depending on feature ssl.
• cert - SSL certificate. The parameter may vary depending on feature ssl.
• logrequests - Log the requests . (Optional parameter. To enable the option click "on".)
• page_php_th - .
• disable_open_basedir - . (Optional parameter. To enable the option click "on".)

Function: wwwdomain.plain

The function is simultaneously used to view and change object's parameters.

View object's parameters:

• Parameters:
  • elid - unique identifier ("name" element of "wwwdomain" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("name" element of "wwwdomain" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• adata - Apache settings .
• ndata - Nginx settings .

Function: wwwdomain.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "wwwdomain" function.

Result: successful operation or error message

Function: wwwdomain.delete.confirm

• maildomain - Delete mail domain . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature email.
• dns - Save records in DNS . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature dns.
• docroot - Save directories and files of the WWW domain . (Optional parameter. To enable the option click "on".)

Function: wwwdomain.enable

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "wwwdomain" function.

Result: successful operation or error message

Function: wwwdomain.disable

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "wwwdomain" function.

Result: successful operation or error message

Function: wwwdomain.log

The function is simultaneously used to view and change object's parameters.

View object's parameters:

• Parameters:
  • elid - unique identifier ("name" element of "wwwdomain" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("name" element of "wwwdomain" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

Function: errpage

Parameters:

• elid - unique identifier ("name" element of "wwwdomain" function).

Result: elements list

• key - The list element unique identifier
• domain - WWW Domain.
• name - Error code.
• url - URL.

Function: errpage.edit

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 "wwwdomain" function).
  • elid - unique identifier ("key" element of "errpage" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("name" element of "wwwdomain" function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("name" element of "wwwdomain" function).
  • elid - unique identifier ("key" element of "errpage" function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• domain - WWW domain.
• name - Error code.

Possible values :

• • 400 - 400 - Bad Request
  • 401 - 401 - Unauthorized
  • 402 - 402 - Payment Required
  • 403 - 403 - Forbidden
  • 404 - 404 - Not Found
  • 405 - 405 - Method Not Allowed
  • 406 - 406 - Not Acceptable
  • 407 - 407 - Proxy Authentication Required
  • 408 - 408 - Request Timeout
  • 409 - 409 - Conflict
  • 411 - 411 - Length Required
  • 412 - 412 - Precondition Failed
  • 413 - 413 - Request Entity Too Large
  • 414 - 414 - Request-URI Too Long
  • 415 - 415 - Unsupported Media Type
  • 416 - 416 - Requested Range Not Satisfiable
  • 417 - 417 - Expectation Failed
  • 500 - 500 - Internal Server Error
  • 501 - 501 - Not Implemented
  • 502 - 502 - Bad Gateway
  • 503 - 503 - Service Unavailable
  • 504 - 504 - Gateway Timeout
  • 505 - 505 - HTTP Version Not Supported

• url - URL.

Function: errpage.delete

Parameters:

• plid - parent list unique identifier ("name" element of "wwwdomain" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "key" element of "errpage" function.

Result: successful operation or error message

Function: wwwredirect

Parameters:

• elid - unique identifier ("name" element of "wwwdomain" function).

Result: elements list

• name - Path.
• code - Code.
• url - Url.

Function: wwwredirect.edit

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 "wwwdomain" function).
  • elid - unique identifier ("name" element of "wwwredirect" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("name" element of "wwwdomain" function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("name" element of "wwwdomain" function).
  • elid - unique identifier ("name" element of "wwwredirect" function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• domain - WWW domain.
• name - Path.
• code - Code.
• url - URL.

Function: wwwredirect.delete

Parameters:

• plid - parent list unique identifier ("name" element of "wwwdomain" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "wwwredirect" function.

Result: successful operation or error message

Function: wwwaddtypes

Parameters:

• elid - unique identifier ("name" element of "wwwdomain" function).

Result: elements list

• key - The list element unique identifier
• domain - WWW domain .
• name - Data type .
• val - File extension .

Function: wwwaddtypes.edit

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 "wwwdomain" function).
  • elid - unique identifier ("key" element of "wwwaddtypes" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("name" element of "wwwdomain" function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("name" element of "wwwdomain" function).
  • elid - unique identifier ("key" element of "wwwaddtypes" function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• domain - Domain .
• name - Data type .
• val - File extension .

Function: wwwaddtypes.delete

Parameters:

• plid - parent list unique identifier ("name" element of "wwwdomain" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "key" element of "wwwaddtypes" function.

Result: successful operation or error message

Function: resets

Parameters:

• elid - unique identifier ("name" element of "wwwdomain" function).

Result: elements list

• reset - The list element unique identifier
• client_ip - IP address of the client.
• uri - Uniform Resource Identifier (URI).
• header - HTTP Header.

Function: resets.edit

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 "wwwdomain" function).
  • elid - unique identifier ("reset" element of "resets" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("name" element of "wwwdomain" function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("name" element of "wwwdomain" function).
  • elid - unique identifier ("reset" element of "resets" function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• client_ip - IP address.
• uri - URI.
• header - HTTP Header.

Function: resets.delete

Parameters:

• plid - parent list unique identifier ("name" element of "wwwdomain" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "reset" element of "resets" function.

Result: successful operation or error message

Function: httpusage

Parameters:

• elid - unique identifier ("name" element of "wwwdomain" function).

Result: elements list

• time - Date.
• in - Input traffic.
• out - Output traffic.
• resptime - Total time of scripts operation.
• requests - Requests number.

Function: httpusage.edit

• period - Period.

E-Mail domains

Function: emaildomain

Result: the list of elements

• name - Domain name.
• default - Default action.
• owner - Owner.
• antispam_disabled - Anti-spam is disabled .
• greylist_disabled - Greylisting is disabled .

Function: emaildomain.edit

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • 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 - Domain name.
• dtype - Default action.

Possible values :

• • nouser - reply error
  • toemail - redirect to e-mail address
  • todomain - redirect to domain

• domain - redirect to.
• mbox - Forward to.
• owner - Owner.
• iptype - Address type .

Possible values :

• • ipv4 - IPv4
  • ipv6 - IPv6

• ip - IP-address .
• ip6 - IPv6 address . The parameter may vary depending on feature ipv6.
• greylist - Enable greylisting. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature greylist.
• spamassassin - Enable SpamAssassin. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature sa.
• avcheck - Enable virus scanning . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature clamav.

Function: emaildomain.delete.confirm

• dns - Keep records in DNS . (Optional parameter. To enable the option click "on".)

Domain names (DNS)

Function: domain

Result: the list of elements

• name - Domain name.
• owner - Owner.

Function: domain.edit

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • 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):

• name - Domain name.
• ip - IP address.
• ns - Name servers. (One or more values space-delimited)
• mx - Mail servers. (One or more values space-delimited)
• owner - Owner.
  If the root value is selected the parameters are denied: 'webdomain','maildomain'

• webdomain - Create www domain. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature www.
• maildomain - Add e-mail domain. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature email.
• buy - Buy a domain . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature domainmarket.

Function: domain.sublist

Parameters:

• elid - unique identifier ("name" element of "domain" function).

Result: elements list

• key - The list element unique identifier
• name - Name.
• type - Type.
• addr - Address.

Function: domain.sublist.edit

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 ("key" element of "domain.sublist" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • 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 "yes".
  • plid - parent list unique identifier ("name" element of "domain" function).
  • elid - unique identifier ("key" element of "domain.sublist" function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• name - Name.
• sdtype - Type.

Possible values :

• • A - A (Internet address)
  • AAAA - AAAA (Internet address v6)
  • CNAME - CNAME (canonical name)
  • DNAME - DNAME (delegated name)
  • NS - NS (name server)
  • MX - MX (mail server)
  • TXT - TXT (text record)
  • SRV - SRV (known network services)
  • PTR - PTR (reverse record)

• addr - Address or domain name.
• prio - Priority.
• wght - The conditional weight of SRV record.
• port - Port.

Function: domain.sublist.delete

Parameters:

• plid - parent list unique identifier ("name" element of "domain" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "key" element of "domain.sublist" function.

Result: successful operation or error message

Function: domain.delete.confirm

• webdomain - Delete WWW domain. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature www.
• maildomain - Delete e-mail domain. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature email.

Function: domain.fix

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

Function: domain.buy

The function is simultaneously used to view and change object's parameters.

View object's parameters:

• Parameters:
  • elid - unique identifier ("name" element of "domain" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • 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):

Function: domain.prop

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• ns - Name servers. (One or more values space-delimited)
• mx - Mail servers. (One or more values space-delimited)
• email - Technical support e-mail address.
• subdom - Additional records. (One or more values space-delimited)
• fixall - Change for all domains. (Optional parameter. To enable the option click "on".)

Function: domain.slave

Result: the list of elements

• addr - Control panel URL .

Function: domain.slave.edit

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 ("addr" element of "domain.slave" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("addr" 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):

• addr - Control panel URL .
• stype - Type.

Possible values :

• • ispmgr - ISPmanager
  • dnsmgr - DNSmanager

• user - Username.
• passwd - Password.

Function: domain.slave.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "addr" element of "domain.slave" function.

Result: successful operation or error message

Management Tools

Databases

Function: db

Result: the list of elements

• dbkey - The list element unique identifier
• name - Database name.
• dbtype - Database type.
• dbuser - Database user.
• owner - Owner.
• size - Size (Mb).

Function: db.edit

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 ("dbkey" element of "db" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("dbkey" 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 - Database name.
• dbtype - Database type.
• owner - Owner.
• dbencoding - Database encoding.
• dbuser - Database user.
• dbusername - New user name.
• dbpassword - Password.
• dbconfirm - Re-enter password.
• dbuserhost - Allow remote access. (Optional parameter. To enable the option click "on".)

Function: db.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "dbkey" element of "db" function.

Result: successful operation or error message

Function: db.users

Parameters:

• elid - unique identifier ("dbkey" element of "db" function).

Result: elements list

• name - User name.
• read - The user is able to read data from the database.
• write - The user is able to write data to the database.
• manage - The user is able to change the database structure.

Function: db.users.edit

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 ("dbkey" 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 "yes".
  • plid - parent list unique identifier ("dbkey" 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 "yes".
  • plid - parent list unique identifier ("dbkey" 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):

• dbuser - Database user.
  If the newuser value is selected the parameters are allowed to use: 'dbusername','dbpassword','dbconfirm'

• dbusername - User name.
• dbpassword - Password.
• dbconfirm - Re-enter password.
• dbuserhost - Allow remote access. (Optional parameter. To enable the option click "on".)
• select_priv - Data access. (Optional parameter. To enable the option click "on".)
• delete_priv - Data access. (Optional parameter. To enable the option click "on".)
• insert_priv - Data access. (Optional parameter. To enable the option click "on".)
• update_priv - Data access. (Optional parameter. To enable the option click "on".)
• create_priv - Structure access. (Optional parameter. To enable the option click "on".)
• drop_priv - Structure access. (Optional parameter. To enable the option click "on".)
• alter_priv - Structure access. (Optional parameter. To enable the option click "on".)
• index_priv - Structure access. (Optional parameter. To enable the option click "on".)
• grant_priv - Other. (Optional parameter. To enable the option click "on".)
• references_priv - Other. (Optional parameter. To enable the option click "on".)
• lock_priv - Other. (Optional parameter. To enable the option click "on".)

Function: db.users.delete

Parameters:

• plid - parent list unique identifier ("dbkey" element of "db" function).
• 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

Function: mysqlusage

Parameters:

• elid - unique identifier ("name" element of "db.users" function).

Result: elements list

• time - Date.
• in - Input traffic.
• out - Output traffic.
• resptime - Total time spent for requests processing.
• requests - Requests number.

Function: mysqlusage.edit

• period - Period.

Function: db.repair

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "dbkey" element of "db" function.

Result: successful operation or error message

Function: db.restore

The function is simultaneously used to view and change object's parameters.

View object's parameters:

• Parameters:
  • elid - unique identifier ("dbkey" element of "db" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("dbkey" element of "db" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• filename - File .

Function: db.backup

The function is simultaneously used to view and change object's parameters.

View object's parameters:

• Parameters:
  • elid - unique identifier ("dbkey" element of "db" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("dbkey" element of "db" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• filename - File .

Firewall

Function: firewall

Result: the list of elements

• port - The list element unique identifier
• name - Service name .
• status - Status .

Function: firewall.edit

The function is simultaneously used to view and change object's parameters.

View object's parameters:

• Parameters:
  • elid - unique identifier ("port" element of "firewall" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("port" element of "firewall" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Service name .
• ftype - Type of connection.

Possible values :

• • open - Open
  • closed - Closed
  • open_partial - Half-open
  • closed_partial - Half-closed

• openip - Allow for . (One or more values space-delimited)
• closeip - Deny for . (One or more values space-delimited)
• actiondeny - Action.
• remoteip - .

Function: firewallexpert

Parameters:

• elid - unique identifier ("port" element of "firewall" function).

Result: elements list

• prior - Priority .
• from - Host address.
• port - Service port .
• protocol - Network protocol .
• action - Action .

Function: firewallexpert.edit

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 ("port" element of "firewall" function).
  • elid - unique identifier ("prior" element of "firewallexpert" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("port" element of "firewall" function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("port" element of "firewall" function).
  • elid - unique identifier ("prior" element of "firewallexpert" function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• from - From.
• prior - Priority.
• protocol - Protocol .

Possible values :

• • tcp - TCP
  • udp - UDP
  • all - All

• portselect - Service .
  If the manual value is selected the parameters are allowed to use: 'port'

• port - Port .
• action - Action .

Possible values :

• • accept - ACCEPT
  • reject - REJECT

• remoteip - .

Function: firewallexpert.delete

Parameters:

• plid - parent list unique identifier ("port" element of "firewall" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "prior" element of "firewallexpert" function.

Result: successful operation or error message

Function: firewallexpert.setting

• fwtype - Access type .

Possible values :

• • open - open
  • closed - closed

Services

Function: services

Result: the list of elements

• name - Name.
• dname - .
• proc - Process name.
• count - Number of processes.
• active - This service is active.
• autostart - This service starts automatically after reboot.
• monitored - Monitor this service with watchdog.
• unavail - Service autostart script cannot be found.

Function: services.edit

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 "services" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("name" element of "services" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Name.
• base - Mode.
  If the none value is selected the parameters are allowed to use: 'start','stop'

• proc - Process name.
• start - Start command.
• stop - Stop command.
• confname - System name.
• type - Type.
  If the process value is selected the parameters are denied: 'ip'

• ip - IP-address.
• autostart - Autostart. (Optional parameter. To enable the option click "on".)
  Active parameter allows the use of the following parameters: 'monitor'

• monitor - Monitoring. (Optional parameter. To enable the option click "on".)

Function: services.delete

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

Function: services.stop

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

Function: services.start

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

Function: services.restart

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

Function: services.options

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• inetdconf - Configuration file.
• inetdstart - Start command.
• inetdstop - Stop command.
• inetdconfname - System name.
• xinetdconf - Configuration file.
• xinetdstart - Start command.
• xinetdstop - Stop command.
• xinetdconfname - System name.
• enflag - Monitoring. (Optional parameter. To enable the option click "on".)
  Active parameter allows the use of the following parameters: 'period','script','notify'

• period - Period.
• script - Script.
• notify - Notifications.
  If the off value is selected the parameters are denied: 'email','mail','from','subject'

• email - E-mail for notifications. (One or more values space-delimited)
• from - Return e-mail address.
• subject - Subject.
• mail - Message.

SSL certificates

Function: certificate

Result: the list of elements

• name - Name.
• expire - Valid until.
• status - Type.
• installed - This certificate is active.

Function: certificate.edit

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• key - Name.
• ctype - Certificate type.

Possible values :

• • self - self-signed
  • request - request
  • ready - existing
  • sign - Sign by the existing

• len - Key length .
• cert - Certificate.
• duration - Period.
• country - 2 Letter country code.
• state - State/Province.
• city - City.
• company - Organization name .
• division - Department.
• name - Domain name.
  If the other value is selected the parameters are allowed to use: 'domain' and the parameters are denied: 'wildcard'

• domain - . (One or more values space-delimited)
• wildcard - Wildcard. (Optional parameter. To enable the option click "on".)
• email - E-mail.
• keydata - Certificate key.
• crtdata - Certificate .
• passwd - Password.
• bdldata - Certificates chain.

Function: certificate.info

The function is simultaneously used to view and change object's parameters.

View object's parameters:

• Parameters:
  • elid - unique identifier ("name" element of "certificate" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("name" element of "certificate" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• ctype - Certificate type.
• expire - Valid until .
• country - 2 Letter Country Code.
• state - State.
• city - City.
• company - Organization name.
• division - Department.
• name - Domain name.
• email - E-Mail.
• issuer_country - 2 Letter Country Code.
• issuer_state - State.
• issuer_city - City.
• issuer_company - Organization name.
• issuer_division - Department.
• issuer_name - Domain name.
• issuer_email - E-Mail.

Function: certificate.subscribe

The function is simultaneously used to view and change object's parameters.

View object's parameters:

• Parameters:
  • elid - unique identifier ("name" element of "certificate" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("name" element of "certificate" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• req - .
• key - .
• crt - .
• bundle - .

Function: certificate.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "certificate" function.

Result: successful operation or error message

Function: certificate.sign

The function is simultaneously used to view and change object's parameters.

View object's parameters:

• Parameters:
  • elid - unique identifier ("name" element of "certificate" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("name" element of "certificate" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• duration - Valid.
• fdata - .

Web-scripts (APS)

Function: webaps.collection

Result: the list of elements

• name - Name .
• version - Version .
• summary - Description .
• status - Status .
• inrep - Web-script is uploaded .

Function: webaps.collection.add

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• path - Path to the archive .

Function: webaps.install

The function is simultaneously used to view and change object's parameters.

View object's parameters:

• Parameters:
  • elid - unique identifier ("name" element of "webaps.collection" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("name" element of "webaps.collection" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• domain - Domain .
• path - Path .

Function: webaps.collection.edit

The function is simultaneously used to view and change object's parameters.

View object's parameters:

• Parameters:
  • elid - unique identifier ("name" element of "webaps.collection" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("name" element of "webaps.collection" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Name .
• version - Version .
• author - Author .
• packager - Packager .
• description - Description .

Function: webaps.collection.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "webaps.collection" function.

Result: successful operation or error message

Function: webaps.collection.access

• ftype - Access type .

Possible values :

• • allow - Allowed for all
  • deny - Denied for all
  • allow_partial - Allowed for
  • deny_partial - Denied for

• userlist - User list . (One or more values space-delimited)

Function: webaps.collection.update

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

Backends

Function: backend

Result: the list of elements

• ip - IP address .
• sc - Number of web-servers .

Function: backend.edit

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 ("ip" element of "backend" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("ip" element of "backend" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• ip - IP address .
• pwd - Password .

Function: backend.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "ip" element of "backend" function.

Result: successful operation or error message

Function: backend.server

Parameters:

• elid - unique identifier ("ip" element of "backend" function).

Result: elements list

• ip - IP address .

Function: backend.server.edit

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 ("ip" element of "backend" function).
  • elid - unique identifier ("ip" element of "backend.server" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("ip" element of "backend" function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("ip" element of "backend" function).
  • elid - unique identifier ("ip" element of "backend.server" function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• ip - IP address .
• default - . (Optional parameter. To enable the option click "on".)

Function: backend.server.delete

Parameters:

• plid - parent list unique identifier ("ip" element of "backend" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "ip" element of "backend.server" function.

Result: successful operation or error message

Maintenance

Backup plan management

Function: backupplan

Result: the list of elements

• id - ID .
• name - Backup plan name.
• disabled - This backup plan is not active.
• local - Backup to local folder.
• ftp - Back up to remote FTP server.
• sftp - Back up to remote sFTP server.
• sftppass - Storage type SftpPassword .
• tgz - The backup will be done in TGZ format.
• tar - The backup will be done in TAR format.
• tbz2 - The backup will be done in TBZ2 format.
• zip - The backup will be done in ZIP format.
• rar - The backup will be done in RAR format.
• running - Backup in progress:.
• empty - This backup plan contains no data to backup.
• period - Period.
• starttime - Start time.
• limits - Limit.

Function: backupplan.edit

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 "backupplan" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("id" element of "backupplan" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Plan name.
• storage - Storage.
  If the local value is selected the parameters are allowed to use: 'ldir' and the parameters are denied: 'ftphost','ftpuser','ftppasswd','ftpdir'

• ldir - Local directory.
• ftphost - FTP server.
• ftpuser - Login.
• ftppasswd - Password.
• ftpdir - Directory.
• archiver - Archiver.
  If the tar value is selected the parameters are denied: 'compress'

• period - Period.
  If the daily value is selected the parameters are allowed to use: 'dlimit','wlimit','mlimit'

• starttime - Start time (hh:mm).
• dlimit - Daily archives.
• wlimit - Weekly archives.
• mlimit - Monthly archives.
• delclient - Client can delete backups. (Optional parameter. To enable the option click "on".)
• overwrite - Overwrite the existing backup . (Optional parameter. To enable the option click "on".)
• compress - Compression level .
• id - .

Function: backupplan.delete.confirm

• delarc - Delete the associated archives. (Optional parameter. To enable the option click "on".)

Function: backupplan.enable

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "backupplan" function.

Result: successful operation or error message

Function: backupplan.disable

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "backupplan" function.

Result: successful operation or error message

Function: backupplan.dobackup

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "id" element of "backupplan" function.

Result: successful operation or error message

Function: backupplan.content

Parameters:

• elid - unique identifier ("id" element of "backupplan" function).

Result: elements list

• name - The list element unique identifier
• module - Data type.
• data - Data.
• disabled - This content is not included in the backup plan.

Function: backupplan.content.edit

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 "backupplan" function).
  • elid - unique identifier ("name" element of "backupplan.content" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("id" element of "backupplan" function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("id" element of "backupplan" function).
  • elid - unique identifier ("name" element of "backupplan.content" function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• type - Action type.
• module - Data type.
  If the file value is selected the parameters are allowed to use: 'filedata' and the parameters are denied: 'mysqldata', 'postgresqldata', 'mgrdatadata', 'emaildata', 'userdata', 'sysfilesdata', 'userinodedata', 'disableduserdata'

• filedata - Path.
• mysqldata - Database.
• postgresqldata - Database.
• mgrdatadata - ISPmanager data.
• emaildata - Mailbox.
• userdata - User.
• sysfilesdata - .
• userinodedata - File limit .
• disableduserdata - .

Function: backupplan.content.delete

Parameters:

• plid - parent list unique identifier ("id" element of "backupplan" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "backupplan.content" function.

Result: successful operation or error message

User import

Function: usermove.login

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• source - Location .
  If the ispmgr value is selected the parameters are allowed to use: 'host','login','passwd' and the parameters are denied: 'fpath', 'owner','pl10desc'

• host - Server .
• login - Login .
• passwd - Password .
• owner - Local user .
• fpath - Path to the archive .

Function: usermove.select

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• user - User .

Function: usermove.run

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• protocol - Data transfer protocol .
• ip - Assign IP-address.
• mergepreset - Preset.
• dnsuser - DNS username.
• dnspass - DNS password .
• nshook - . (Optional parameter. To enable the option click "on".)
• noobject - Do not import the following items .

Fix disk quotas

Function: repairdiskquota

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

Function: repairdiskquotaresult

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• checkresult - .

Spam Filter

Dnsbl block lists

Function: dnsbl

Result: the list of elements

• name - Block lists.

Function: dnsbl.edit

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 "dnsbl" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("name" element of "dnsbl" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Block lists.

Function: dnsbl.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "dnsbl" function.

Result: successful operation or error message

Greylisting

Function: greylist

Result: the list of elements

• key - The list element unique identifier
• from - Sender.
• rcpt - Recipient .

Function: greylist.edit

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 "greylist" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("key" element of "greylist" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• tsender - Sender type.
• sender - Sender.
• trcpt - Recipient type.
  If the common value is selected the parameters are denied: 'rcpt'

• rcpt - Recipient .

Function: greylist.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "key" element of "greylist" function.

Result: successful operation or error message

Spamassassin

Function: spamassassin

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• required_score - Required score .
• rewrite_subject - Add to the "Subject" field .
• report_safe - Report type .
• report_contact - Contact email.

Whitelist

Function: whitelist

Result: the list of elements

• sender - Sender.
• action - Action.

Function: whitelist.edit

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 ("sender" element of "whitelist" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("sender" element of "whitelist" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• sender - Sender.
• action - Action.

Function: whitelist.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "sender" element of "whitelist" function.

Result: successful operation or error message

Blacklist

Function: blacklist

Result: the list of elements

• sender - Mail sender.
• action - Action.

Function: blacklist.edit

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 ("sender" element of "blacklist" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("sender" element of "blacklist" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• sender - Mail sender.
• action - Reject.
  If the reject value is selected the parameters are denied: 'errmsg'

• errmsg - Error message.

Function: blacklist.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "sender" element of "blacklist" function.

Result: successful operation or error message

Email limit

Function: mailrate

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• limit - Email limit .

Server Statistics

Usage statistics

Function: usagestat

Result: the list of elements

• name - Name.
• value - Used/Limit. Attributes :
  • used - The used number.
  • limit - Max value limitation

System information

Function: sysinfo

Result: the list of elements

• name - Parameter.
• value - Value.

System resources

Function: totalresourceusage

Result: the list of elements

• account - Account.
• memory - Memory (GB).
• utime - CPU user time (sec) .
• stime - CPU system time (sec) .
• etime - Running time (minutes).
• io - Input/output operations.
• mysqltime - MySQL time .
• mysqlrequests - Number of MySQL requests .

Function: totalresourceusage.period

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• from - Start date .
• to - End date .

Function: usersystemresources

Parameters:

• elid - unique identifier ("account" element of "totalresourceusage" function).

Result: elements list

• time - Date.
• memory - Memory (GB).
• utime - CPU user time (sec) .
• stime - CPU system time (sec) .
• etime - Uptime (minutes).
• io - I/O operations.
• mysqltime - MySQL time .
• mysqlrequests - Number of MySQL requests .

Function: usersystemresources.edit

• period - Period.

Active connections

Function: netactconn

Result: the list of elements

• cid - The list element unique identifier
• proto - Protocol .
• laddr - Local address .
• lport - Service .
• faddr - External address .
• pid - Process ID .
• pname - Process name .
• pcount - Flows .

Function: netactconn.drop

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "cid" element of "netactconn" function.

Result: successful operation or error message

Function: netactconn.firewall

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "cid" element of "netactconn" function.

Result: successful operation or error message

Background tasks

Function: longtask

Result: the list of elements

• sname - Script name .
• pid - PID-file .
• queue - Queue name .
• queue_id - Number in the queue .
• ok - The task was successfully processed .
• error - Failed to process the task .
• inqueue - Task in the queue .
• running - In progress .

Function: longtask.edit

The function is simultaneously used to view and change object's parameters.

View object's parameters:

• Parameters:
  • elid - unique identifier ("pid" element of "longtask" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("pid" element of "longtask" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• sname - Script name .
• pid - PID-file .
• queue - Queue name .
• queue_id - Number in the queue.
• params - Additional information .

Function: longtask.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "pid" element of "longtask" function.

Result: successful operation or error message

Load statistics

Function: currentload

Result: the list of elements

• name - Name .

Server Settings

Server parameters

Function: srvparam

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• srvname - Server name.
• timezone - Time zone.
• rootfwd - Forward root e-mail. The parameter may vary depending on feature email.

IP-addresses

Function: iplist

Result: the list of elements

• name - IP-address.
• count - Number of WWW domains.
• domain - Default WWW domain.
• rname - Reverse domain name.

Function: iplist.edit

The function is simultaneously used to view and change object's parameters.

View object's parameters:

• Parameters:
  • elid - unique identifier ("name" element of "iplist" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("name" element of "iplist" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• type - Type of IP-address .
  If the custom value is selected the parameters are allowed to use: 'name'

• name - IP-address.
• stat - Status.

Possible values :

• • free - Free
  • shared - Shared
  • assigned - Assigned

• owner - Owner.
• domain - Default domain. The parameter may vary depending on feature www.
• rname - Reverse domain name. The parameter may vary depending on feature ipmgr.

Anonymous FTP

Function: ftpanon

Result: the list of elements

• ip - Server IP address.
• owner - Owner.
• docroot - Server directory.
• disabled - Access temporarily denied.
• upload - Upload to anonymous FTP is enabled.
• disk - Disk. Attributes :
  • used - The used number.
  • limit - Max value limitation

Function: ftpanon.edit

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 ("ip" element of "ftpanon" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("ip" element of "ftpanon" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• ip - Server IP address.
• docroot - Server directory.
• owner - Service owner.
• disklimit - Disk quota. The parameter may vary depending on feature quota.
• upload - Allow upload. (Optional parameter. To enable the option click "on".)
  Active parameter allows the use of the following parameters: 'uploaddir'

• uploaddir - Upload directory.

Function: ftpanon.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "ip" element of "ftpanon" function.

Result: successful operation or error message

Function: ftpanon.enable

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "ip" element of "ftpanon" function.

Result: successful operation or error message

Function: ftpanon.disable

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "ip" element of "ftpanon" function.

Result: successful operation or error message

PHP configuration

Function: phpconf

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• exectime - Execution time.
• memlimit - Memory limit.
• postsize - Request maximum size.
• uploadsize - Maximum size for files.
• regglobal - register_globals. (Optional parameter. To enable the option click "on".)
• displayerror - display_errors. (Optional parameter. To enable the option click "on".)
• logerror - log_errors. (Optional parameter. To enable the option click "on".)
• email - E-mail.

PHP extensions

Function: phpextensions

Result: the list of elements

• name - Name.
• enabled - This PHP extension is enabled.
• builtin - This PHP extension is locked.
• installing - Installation in progress .

Function: phpextensions.enable

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

Function: phpextensions.disable

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

Function: phpextensions.edit

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Name.

Perl modules

Function: perlmodules

Result: the list of elements

• name - Name.
• installing - .

Function: perlmodules.edit

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Name.

Python modules

Function: pythonmodules

Result: the list of elements

• name - Name .
• installing - .

Function: pythonmodules.edit

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Name .

Applications

Function: feature

Result: the list of elements

• name - Application name.
• version - Installed version.
• active - This application is installed and active.
• installing - Installation in progress.
• level - Type.

Function: feature.edit

The function is simultaneously used to view and change object's parameters.

View object's parameters:

• Parameters:
  • elid - unique identifier ("name" element of "feature" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("name" element of "feature" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• version - Version.

Function: feature.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "feature" function.

Result: successful operation or error message

Function: feature.packcache

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

Function: feature.enable

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "feature" function.

Result: successful operation or error message

Function: feature.disable

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "feature" function.

Result: successful operation or error message

Experimental Features

Function: expfeature

Result: the list of elements

• id - The list element unique identifier
• name - Option name.
• desc - Short Description.
• active - Active.

Function: expfeature.edit

The function is simultaneously used to view and change object's parameters.

View object's parameters:

• Parameters:
  • elid - unique identifier ("id" element of "expfeature" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("id" element of "expfeature" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• accept - I have read and agreed . (Optional parameter. To enable the option click "on".)

Plug-ins

Function: plugin

Result: the list of elements

• name - Plug-in name .
• desc - Brief description .
• version - Version .
• bad - The plug-in failed due to errors in its description. .
• newver - .

Function: plugin.collection

Result: the list of elements

• name - Plug-in name .
• desc - Description .
• version - Version .
• author - Author .

Function: plugin.install

The function is simultaneously used to view and change object's parameters.

View object's parameters:

• Parameters:
  • elid - unique identifier ("name" element of "plugin.collection" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("name" element of "plugin.collection" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• agree - I was warned about consequences of my actions . (Optional parameter. To enable the option click "on".)

Function: plugin.info

The function is simultaneously used to view and change object's parameters.

View object's parameters:

• Parameters:
  • elid - unique identifier ("name" element of "plugin.collection" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("name" element of "plugin.collection" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• description - Detailed description .
• interpretator - Programming language .
• require - Required modules .
• author - Author .
• contact - Contact information .

Function: plugin.info

The function is simultaneously used to view and change object's parameters.

View object's parameters:

• Parameters:
  • elid - unique identifier ("name" element of "plugin" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("name" element of "plugin" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• description - Detailed description .
• interpretator - Programming language .
• require - Required modules .
• author - Author .
• contact - Contact information .

Function: plugin.update

Function: plugin.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "plugin" function.

Result: successful operation or error message

Function: plugin.source

Result: the list of elements

• url - Source URL .

Function: plugin.source.edit

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 ("url" element of "plugin.source" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("url" element of "plugin.source" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• url - Source URL .

Function: plugin.source.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "url" element of "plugin.source" function.

Result: successful operation or error message

Function: plugin.source.refresh

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "url" element of "plugin.source" function.

Result: successful operation or error message

Cluster settings

Roles

Function: clusterroles

Result: the list of elements

• name - Name .
• descr - Description .

Function: clusterroles.edit

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 "clusterroles" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("name" element of "clusterroles" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Name .
• descr - Description .

Function: clusterroles.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "clusterroles" function.

Result: successful operation or error message

Function: clusterroles.startscripts

Parameters:

• elid - unique identifier ("name" element of "clusterroles" function).

Result: elements list

• priority - Priority .
• command - Command .

Function: clusterroles.startscripts.edit

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 "clusterroles" function).
  • elid - unique identifier ("command" element of "clusterroles.startscripts" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("name" element of "clusterroles" function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("name" element of "clusterroles" function).
  • elid - unique identifier ("command" element of "clusterroles.startscripts" function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• command - Command .
• priority - Priority .

Function: clusterroles.startscripts.delete

Parameters:

• plid - parent list unique identifier ("name" element of "clusterroles" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "command" element of "clusterroles.startscripts" function.

Result: successful operation or error message

Function: clusterroles.stopscripts

Parameters:

• elid - unique identifier ("name" element of "clusterroles" function).

Result: elements list

• priority - Priority .
• command - Command .

Function: clusterroles.stopscripts.edit

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 "clusterroles" function).
  • elid - unique identifier ("command" element of "clusterroles.stopscripts" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("name" element of "clusterroles" function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("name" element of "clusterroles" function).
  • elid - unique identifier ("command" element of "clusterroles.stopscripts" function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• command - Command .
• priority - Priority .

Function: clusterroles.stopscripts.delete

Parameters:

• plid - parent list unique identifier ("name" element of "clusterroles" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "command" element of "clusterroles.stopscripts" function.

Result: successful operation or error message

Nodes

Function: clusternodes

Result: the list of elements

• ip - IP-address .
• roles - Roles .
• wscount - Number of web-servers .
• in_progress - Installation in progress .

Function: clusternodes.new

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• ip - IP-address .
• install - . (Optional parameter. To enable the option click "on".)

Function: clusternodes.edit

The function is simultaneously used to view and change object's parameters.

View object's parameters:

• Parameters:
  • elid - unique identifier ("ip" element of "clusternodes" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("ip" element of "clusternodes" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• ip - IP-address.

Function: clusternodes.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "ip" element of "clusternodes" function.

Result: successful operation or error message

Function: clusternodes.roles

Parameters:

• elid - unique identifier ("ip" element of "clusternodes" function).

Result: elements list

• name - Name .

Function: clusternodes.roles.edit

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 ("ip" element of "clusternodes" function).
  • elid - unique identifier ("name" element of "clusternodes.roles" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("ip" element of "clusternodes" function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("ip" element of "clusternodes" function).
  • elid - unique identifier ("name" element of "clusternodes.roles" function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• name - Name .
  If the ClusterCtl value is selected the parameters are allowed to use: 'port', 'password', 'accept_logs' and the parameters are denied: 'max_connections', 'percent_of_total_connections', 'priority', 'enabled', 'listen', 'keep_alive_timeout', 'backend_connect_timeout', 'backend_down_retry_time', 'max_save_query_length', 'protocol_timeout', 'disabled_file', 'not_found_file', 'all_backends_down_file', 'log', 'log_protocol_errors', 'max_open_http_logs', 'enable_sendfile', 'fh_cache_size', 'fh_cache_timeout', 'errors_watch_interval', 'errors_watch_percent', 'errors_watch_sleep'

• port - Port .
• password - Password .
• accept_logs - Accept HTTP logs . (Optional parameter. To enable the option click "on".)
• max_connections - Connection limit .
• percent_of_total_connections - Percent of connections .
• priority - Priority .
• enabled - Active . (Optional parameter. To enable the option click "on".)
• listen - Socket address . (One or more values space-delimited)
• keep_alive_timeout - HTTP Keep-Alive.
• backend_connect_timeout - Connection timeout .
• backend_down_retry_time - Retry time .
• max_save_query_length - SQL name .
• http_protocol_timeout - HTTP/HTTPS timeout .
• https_protocol_timeout - HTTP/HTTPS timeout .
• disabled_file - Site is disabled .
• not_found_file - Site not found .
• all_backends_down_file - Site without backends .
• log_host_not_found - Log requests . (Optional parameter. To enable the option click "on".)
• log_host_disabled - Log requests . (Optional parameter. To enable the option click "on".)
• log_protocol_errors - . (Optional parameter. To enable the option click "on".)
• max_open_http_logs - HTTP log cache size .
• enable_sendfile - . (Optional parameter. To enable the option click "on".)
• fh_cache_size - File descriptor cache size .
• fh_cache_timeout - Cache reset time .
• errors_watch_interval - HTTP error view interval .
• errors_watch_percent - Maximum percent of HTTP errors .
• errors_watch_sleep - HTTP testing time .

Function: clusternodes.roles.delete

Parameters:

• plid - parent list unique identifier ("ip" element of "clusternodes" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "clusternodes.roles" function.

Result: successful operation or error message

Function: clusternodes.webservers

Parameters:

• elid - unique identifier ("ip" element of "clusternodes" function).

Result: elements list

• ip - IP-address .

Function: clusternodes.webservers.edit

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 ("ip" element of "clusternodes" function).
  • elid - unique identifier ("ip" element of "clusternodes.webservers" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("ip" element of "clusternodes" function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • plid - parent list unique identifier ("ip" element of "clusternodes" function).
  • elid - unique identifier ("ip" element of "clusternodes.webservers" function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• ip - IP-address.
• config - Configuration file .
• folder - Directory .
• default - . (Optional parameter. To enable the option click "on".)

Function: clusternodes.webservers.delete

Parameters:

• plid - parent list unique identifier ("ip" element of "clusternodes" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "ip" element of "clusternodes.webservers" function.

Result: successful operation or error message

Function: clusternodes.dsmanager

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• url - Control panel URL .
• user - User .
• passwd - Password .

MySQL failover

Function: mysqlfailover

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• email - Notification e-mail .
• errors - Number of errors .
• interval - Interval .
• notifyall - . (Optional parameter. To enable the option click "on".)

Other Settings

Policy

Function: policy

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• disableoversell - . (Optional parameter. To enable the option click "on".)
• disableexcesslimit - . (Optional parameter. To enable the option click "on".)
• overtaff - . (Optional parameter. To enable the option click "on".)
• showwwwalias - . (Optional parameter. To enable the option click "on".)
• ftpprefix - . (Optional parameter. To enable the option click "on".)
• dbprefix - . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature db.
• dbuserprefix - . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature db.
• includedbinquota - . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature db.
  Active parameter allows the use of the following parameters: 'dbresizequota'

• dbresizequota - . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature db.
• autopreset - . (Optional parameter. To enable the option click "on".)
  Active parameter allows the use of the following parameters: 'ucautopreset'

• ucautopreset - . (Optional parameter. To enable the option click "on".)
• insecuredomain - . (Optional parameter. To enable the option click "on".)
  Active parameter denies the following parameters: 'rootmixdomain','resellermixdomain'

• rootmixdomain - . (Optional parameter. To enable the option click "on".)
• resellermixdomain - . (Optional parameter. To enable the option click "on".)
• allowuserinstallphp - . (Optional parameter. To enable the option click "on".)
• allowuserinstallperl - . (Optional parameter. To enable the option click "on".)
• allowuserinstallpython - . (Optional parameter. To enable the option click "on".)
• alwaysallowsharedip - . (Optional parameter. To enable the option click "on".)
• allowftpprivatedir - . (Optional parameter. To enable the option click "on".)

Presets

Function: preset

Result: the list of elements

• name - Name.
• type - Type.
• usecount - Amount.
• disk - Disk quota.
• domain - Domains.
• database - Databases.
• bandwidth - Monthly traffic.
• cgi - CGI is active for the WWW domains of this preset.
• wsgi - WSGI is active for the WWW domains of this user .
• php - PHP is active for the WWW domains of this preset.
• ssi - SSI is active for the WWW domains of this preset.
• ssl - HTTPS is active for the WWW domains of this preset.
• shell - Shell access is activated for this preset.

Function: preset.edit

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • 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.
• ptype - Type.

Possible values :

• • user - User
  • reseller - Reseller

• shell - Shell access. (Optional parameter. To enable the option click "on".)
• ssl - SSL. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature ssl.
• cgi - CGI. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature cgi.
  Active parameter allows the use of the following parameters: 'phpcgi','phpfcgi'

• wsgi - WSGI. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature wsgi.
• ssi - SSI. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature ssi.
• phpmod - PHP as Apache module. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature phpmod.
• phpcgi - PHP as CGI. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature phpcgi.
• phpfcgi - PHP as FastCGI. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature phpfcgi.
• safemode - PHP safe_mode. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature phpmod.
• userlimit - Users. (Value. Use "10000" to represent "infinity")
• disklimit - Disk quota. The parameter may vary depending on feature quota.
• ftplimit - FTP accounts. (Value. Use "10000" to represent "infinity") The parameter may vary depending on feature ftp.
• maillimit - Mailboxes. (Value. Use "10000" to represent "infinity") The parameter may vary depending on feature email.
• domainlimit - Domains. (Value. Use "10000" to represent "infinity") The parameter may vary depending on feature dns.
• webdomainlimit - WWW domains. (Value. Use "10000" to represent "infinity") The parameter may vary depending on feature www.
• maildomainlimit - E-mail domains. (Value. Use "10000" to represent "infinity") The parameter may vary depending on feature email.
• baselimit - Databases. (Value. Use "10000" to represent "infinity") The parameter may vary depending on feature db.
• baseuserlimit - Database users. (Value. Use "10000" to represent "infinity") The parameter may vary depending on feature db.
• bandwidthlimit - Monthly traffic. (Value. Use "100000000" to represent "infinity")
• iplimit - IP addresses. (Value. Use "100000" to represent "infinity")
• ip6limit - IPv6. (Value. Use "100000" to represent "infinity") The parameter may vary depending on feature ipv6.
• cpulimit - CPU limit. (Value. Use "100000" to represent "infinity")
• memlimit - Memory limit. (Value. Use "100000" to represent "infinity")
• proclimit - Process limit. (Value. Use "100000" to represent "infinity")
• mysqlquerieslimit - Requests to MySQL. (Value. Use "100000000" to represent "infinity") The parameter may vary depending on feature dbhaslimits.
• mysqlupdateslimit - MySQL updates . (Value. Use "100000000" to represent "infinity") The parameter may vary depending on feature dbhaslimits.
• mysqlconnectlimit - Connections to MySQL. (Value. Use "100000000" to represent "infinity") The parameter may vary depending on feature dbhaslimits.
• mysqluserconnectlimit - Simultaneous connections to MySQL . (Value. Use "100000000" to represent "infinity") The parameter may vary depending on feature dbhasuconnlimits.
• maxclientsvhost - Apache mpm-itk workers. (Value. Use "100000000" to represent "infinity") The parameter may vary depending on feature apache-mpm-itk.
• limitconn - Simultaneous connections per session . (Value. Use "65535" to represent "infinity") The parameter may vary depending on feature nginx.
• mailrate - Email limit . (Value. Use "100000000" to represent "infinity") The parameter may vary depending on feature mailrate.
• wwwcharset - Encoding.
• wwwindexpage - Index page.
• phphandler - PHP handler .

Function: preset.delete

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

Function: preset.access

Parameters:

• elid - unique identifier ("name" element of "preset" function).

Result: elements list

• ftitle - Module name.
• name - Function name.
• disabled - This module is not active for this preset.

Function: preset.access.enable

Parameters:

• plid - parent list unique identifier ("name" element of "preset" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "preset.access" function.

Result: successful operation or error message

Function: preset.access.disable

Parameters:

• plid - parent list unique identifier ("name" element of "preset" function).
• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "preset.access" function.

Result: successful operation or error message

Function: preset.import

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• host - Address.
• user - Username.
• passwd - Password.

DNS settings

Function: domain.prop

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• ns - Name servers. (One or more values space-delimited)
• mx - Mail servers. (One or more values space-delimited)
• email - Technical support e-mail address.
• subdom - Additional records. (One or more values space-delimited)
• fixall - Change for all domains. (Optional parameter. To enable the option click "on".)

Logs rotation

Function: wwwdomain.log

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

Brand settings

Function: brand

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• site - Link to your web site (e.g. http://my-hosting-company.com).
• mainlogo - .
• loginlogo - .
• favicon - .
• reset - Reset all the branding settings . (Optional parameter. To enable the option click "on".)
• h - Hue .
• s - Saturation .
• l - Brightness .
• headinclude - Add to HEAD.

Slave servers

Function: slave

Result: the list of elements

• name - Control panel URL .

Function: slave.edit

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 "slave" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("name" element of "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 .
• user - Login.
• passwd - Password.

Function: slave.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "slave" function.

Result: successful operation or error message

Function: slave.su

Integration with IPmanager

Function: ipmgr

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• server - Server IP-address.
• user - Username.
• passwd - Password.

Favourites

Function: usermenu

Result: the list of elements

• name - The list element unique identifier
• ntitle - Name .
• favorite - The menu item is in your Favourites .
• popular - This menu item is often used .

Function: usermenu.enable

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "usermenu" function.

Result: successful operation or error message

Function: usermenu.disable

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "usermenu" function.

Result: successful operation or error message

General settings

Function: usrparam

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Username.
• email - E-mail for notifications .
• email - E-mail for notifications . The parameter may vary depending on feature billmgr.
• changed - Theme.
• theme - Theme.
• lang - Language.
• timezone - Time zone.
• passwd - Password.
• confirm - Re-enter password.
• atype - Access to the control panel.
  If the atany value is selected the parameters are denied: 'addr'

• addr - Allowed IP-addresses. (One or more values space-delimited)
• startpage - Start page.
• rows - Rows per page.
• recordlimit - Number of records .
• buttonview - Toolbar view.

Control panel URL

Function: mgrurl

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• subdomain - Use subdomains when reducing privileges . (Optional parameter. To enable the option click "on".)
• allowhttp - Allow HTTP requests. (Optional parameter. To enable the option click "on".)
• ihttp - . (Optional parameter. To enable the option click "on".)
  Active parameter allows the use of the following parameters: 'type','ip','port'

• type - Type .
• ip - IP address.
• port - Port .
• bydomain - . (Optional parameter. To enable the option click "on".)
  Active parameter allows the use of the following parameters: 'mgrdomain'

• domain - Domain name .
• bypath - . (Optional parameter. To enable the option click "on".)
  Active parameter allows the use of the following parameters: 'mgrpath','mgrimg','mgrcgi'

• mgrpath - Control panel .

Help

License

Function: softinfo

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• os - OS version.
• mgrver - Current version.
• mgrbuild - Build date.
• licid - License ID.
• licip - License IP.
• licname - License name.
• licdate - Valid until .

Updates

Function: updatelist

Result: the list of elements

• id - The list element unique identifier
• version - Version.
• release - Release date.
• lines - Number of changes.
• backup - Backup date.

Function: updatelist.changelog

Parameters:

• elid - unique identifier ("id" element of "updatelist" function).

Result: elements list

• id - The list element unique identifier
• description - Description.
• isp1 - ISPmanager Lite.
• isp2 - ISPmanager Pro.
• isp3 - ISPmanager Cluster.
• bill1 - BILLmanager Standard.
• bill2 - BILLmanager Advanced.
• bill3 - BILLmanager Corparate.
• changetype - Type.

Function: updatelist.restore

The function is simultaneously used to view and change object's parameters.

View object's parameters:

• Parameters:
  • elid - unique identifier ("id" element of "updatelist" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("id" element of "updatelist" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

Function: updatelist.settings

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• os - Operating system.
• mgrver - Current version.
• mgrbuild - Compilation date.
• vertype - Version type.
• srvver - Latest version.
• mirror - Mirror.
• autoupdate - Automatic update. (Optional parameter. To enable the option click "on".)

Function: updatelist.updatenow

Wish list

Function: wishlist

Result: the list of elements

• id - ID .
• name - Name.
• created - Date .
• vote - Votes .
• jobeval - Labour intensity .
• prio - Priority .
• status - Status .

Function: wishlist.edit

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 "wishlist" function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("id" element of "wishlist" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Name.
• desc - Description .
• myvote - Available votes .
• vote - Add my vote.

Function: wishlist.vote

• myvote - Available votes .
• vote - Add my votes (for each feature) .

Function: wishlist.refresh

Error log

Function: errorjournal

Result: the list of elements

• date - Date .
• funcname - Function .
• lv_12 - .
• lv_11 - .
• lv_10 - .
• lv_7 - Administrator .
• lv_6 - Reseller .
• lv_5 - User .
• lv_4 - User with shell access .
• lv_3 - FTP account .
• lv_2 - Mailbox .
• user - User .
• status - Status .

Function: errorjournal.settings

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 "yes".
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• level - Logging level .

Function: errorjournal.edit

The function is simultaneously used to view and change object's parameters.

View object's parameters:

• Parameters:
  • elid - unique identifier ("date" element of "errorjournal" function)
• Result: parameters list

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "yes".
  • elid - unique identifier ("date" element of "errorjournal" function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• email - Email .
• drop - Delete the report once it is sent . (Optional parameter. To enable the option click "on".)
• data - .

Function: errorjournal.delete

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "date" element of "errorjournal" function.

Result: successful operation or error message

---

• Use the "featurelist" API function to get the list of active features.