ISPmanager API/Reseller

From ISPWiki

Jump to: navigation, search
Legend
  • Image:isp_lite.png - available in ISPmanager Lite
  • Image:isp_pro.png - available in ISPmanager Professional
  • Image:isp_cluster.png - available in ISPmanager Cluster

Contents

See also


Reseller

Accounts Management

Users

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
User management

Function: user

Result: the list of elements

  • name - Name.
  • slave - Server.
  • 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


Create. Change. Edit user

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:

Create an object:

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. Image:isp_pro.png Image:isp_cluster.png
  • ip - IP-address.
  • ip6 - IPv6. The parameter may vary depending on feature ipv6.
  • domain - Domain.
  • preset - Preset.
  • email - E-mail. Image:isp_pro.png Image:isp_cluster.png
  • welcome - Send message. (Optional parameter. To enable the option click "on".) Image:isp_pro.png Image:isp_cluster.png
  • 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. Image:isp_pro.png Image:isp_cluster.png
  • 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 - Concurrent 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 - Concurrent connections per session. (Value. Use "65535" to represent "infinity") The parameter may vary depending on feature nginx. Image:isp_pro.png Image:isp_cluster.png
  • mailrate - Email limit . (Value. Use "100000000" to represent "infinity") The parameter may vary depending on feature mailrate.
  • note - .


Delete the selected user

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


Enable the selected user account and all the WWW domains of this user

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


Disable the selected user account and all the WWW domains of this user

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


IP-addresses management

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.


IP-address parameters . View. Change

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. Image:isp_pro.png Image:isp_cluster.png

Possible values :

    • free - Free
    • shared - Shared
    • assigned - Assigned
If the free value is selected the parameters are allowed to use: 'domain' and the parameters are denied: 'owner'
If the shared value is selected the parameters are allowed to use: 'domain' and the parameters are denied: 'owner'
If the assigned value is selected the parameters are allowed to use: 'owner','domain'
If the hidden value is selected the parameters are denied: 'domain','owner'
If the mutual value is selected the parameters are allowed to use: 'domain' and the parameters are denied: 'owner'
  • owner - Owner. Image:isp_pro.png Image:isp_cluster.png
  • domain - Default domain. The parameter may vary depending on feature www.
  • rname - Reverse domain name. The parameter may vary depending on feature ipmgr. Image:isp_pro.png Image:isp_cluster.png


Access to modules

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.


Enable the access to the selected module(s) 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


Disable the access to the selected module(s) for this user

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


Usage of system resources

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 .


Report period

Function: usersystemresources.edit

  • period - Period.


Message to support centre

Function: new.msg

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


Set filter by the selected user

Function: user.setfilter


Domains

WWW domains

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
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.


Create. Change. Edit properties of the selected 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:

Create an object:

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. Image:isp_cluster.png
    If the ipv4 value is selected the parameters are allowed to use: 'ip4' and the parameters are denied: 'ip6'
If the ipv6 value is selected the parameters are allowed to use: 'ip6' and the parameters are denied: 'ip4'
  • 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.
  • tech - Technical domain. (Optional parameter. To enable the option click "on".) Image:isp_pro.png Image:isp_cluster.png
  • logrequests - Log the requests . (Optional parameter. To enable the option click "on".) Image:isp_cluster.png
  • page_php_th - .
  • disable_open_basedir - . (Optional parameter. To enable the option click "on".)
  • static_ext - File extensions . (One or more values space-delimited)
  • static_regex - File extensions . (One or more values space-delimited)


Delete the selected WWW domain

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


Confirm that you want to delete the WWW domain

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".)


Enable the selected WWW domain

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


Disable the selected WWW domain

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


Troubleshooting . View. Change

Function: wwwdomain.troubleshoot

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):

  • report - .


CMS optimization. View. Change

Function: wwwdomain.optimize

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):

  • list - List of CMS.


WWW domain default settings . View. Change

Function: wwwdomain.prop

The function is simultaneously used to view and change form's data

View data:

Change the data:

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

  • tech - Technical domain.


Logs rotation. View. Change

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):


Error pages

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.


Create. Change. Edit error page

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.


Delete the selected error page

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


WWW redirects

Function: wwwredirect

Parameters:

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

Result: elements list

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


Create. Change. Edit redirect

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.


Delete the selected redirect

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


MIME types

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 .


Create. Change. Edit MIME type

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 .


Delete the selected MIME type

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


Rules to reset HTTP requests

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.


Create. Change. Rule settings

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.


Remove rules

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


Usage of HTTP resources

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.


Report period

Function: httpusage.edit

  • period - Period.



  • Use the "featurelist" API function to get the list of active features.
Was this helpful? Yes | No
Personal tools