ISPmanager API/User (siteadmin)

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


User (siteadmin)

Main Features

FTP accounts

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
FTP accounts

Function: ftp

Result: the list of elements

  • name - Name.
  • home - Home directory.
  • disabled - This FTP account is not active.
  • shell - Shell access is active for this FTP account.
  • note - Notes:.
  • disk - Disk. Attributes :
    • used - The used number.
    • limit - Max value limitation


Create. Change. Edit FTP account

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

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

  • name - Name.
  • passwd - Password.
  • confirm - Re-enter password.
  • htype - Home directory.
    If the docroot value is selected the parameters are allowed to use: 'domain' and the parameters are denied: 'dir','disklimit', 'shell'
If the custom value is selected the parameters are allowed to use: 'dir' and the parameters are denied: 'domain','disklimit','shell'
If the private value is selected the parameters are allowed to use: 'disklimit','shell' and the parameters are denied: 'domain', 'dir'
  • domain - Domain.
  • dir - Directory.
  • disklimit - Disk quota. The parameter may vary depending on feature quota.
  • shell - Shell access. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature InsecureHome.
  • note - Notes. Image:isp_pro.png Image:isp_cluster.png


Delete the selected FTP account

Function: ftp.delete

Parameters:

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

Result: successful operation or error message


Enable the selected FTP account

Function: ftp.enable

Parameters:

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

Result: successful operation or error message


Disable the selected FTP account

Function: ftp.disable

Parameters:

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

Result: successful operation or error message


World Wide Web

Redirects

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
WWW redirects

Function: wwwredirect

Result: the list of elements

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

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "yes".
    • elid - unique identifier ("name" element of "wwwredirect" function)
    • additional query parameters ...
  • Result: successful 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:

  • 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


Error pages

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
Error pages

Function: errpage

Result: the list of elements

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

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "yes".
    • elid - unique identifier ("key" element of "errpage" function)
    • additional query parameters ...
  • Result: successful 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:

  • 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


MIME types

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
MIME types

Function: wwwaddtypes

Result: the list of elements

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

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "yes".
    • elid - unique identifier ("key" element of "wwwaddtypes" function)
    • additional query parameters ...
  • Result: successful 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:

  • 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


WWW logs

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
WWW logs

Function: logs

Result: the list of elements

  • name - Name.
  • size - Size.
  • time - Modification time.
  • count - Saved.
  • total - Total size.


Log. View. Change

Function: logs.edit

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

View object's parameters:

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

Change an object:

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

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

  • lines - Number of rows displayed.

Possible values :

    • 100 -
    • 500 -
    • 1000 -
    • 2000 -
    • 10000 -
  • fdata - .


Clean/delete the selected log files

Function: logs.delete

Parameters:

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

Result: successful operation or error message


Directory access

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
Password protected directories

Function: diraccess

Result: the list of elements

  • name - Path.


Add protected directory. View. Change

Function: diraccess.edit

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

  • name - Path.
  • name - Path.


Delete the protection of the selected directory

Function: diraccess.delete

Parameters:

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

Result: successful operation or error message


Users protected directory

Function: diraccess.user

Parameters:

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

Result: elements list

  • name - Username.


Create. Change. Edit user

Function: diraccess.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:
    • plid - parent list unique identifier ("name" element of "diraccess" function).
    • elid - unique identifier ("name" element of "diraccess.user" 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 "diraccess" 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 "diraccess" function).
    • elid - unique identifier ("name" element of "diraccess.user" function)
    • additional query parameters ...
  • Result: successfull operation or error message

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

  • name - Username.
  • passwd - Password.
  • confirm - Re-enter password.


Delete the selected user

Function: diraccess.user.delete

Parameters:

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

Result: successful operation or error message


E-Mail

E-Mail groups

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
E-mail groups

Function: emailgroup

Result: the list of elements

  • name - E-mail address.
  • members - Members.


Create. Change. Edit e-mail group

Function: emailgroup.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 "emailgroup" 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.
  • members - Members. (One or more values space-delimited)
  • 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.


Delete the selected e-mail group

Function: emailgroup.delete

Parameters:

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

Result: successful operation or error message


E-Mail redirects

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
E-mail redirects

Function: emailredirect

Result: the list of elements

  • name - E-mail address.
  • forward - Forward to.


Create. Change. Edit e-mail redirect

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

Create an object:

Change an object:

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

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

  • name - Name.
  • domain - E-mail domain.
  • forward - Forward to.
  • greylist - Enable Greylisting. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature greylist.


Delete the selected redirect

Function: emailredirect.delete

Parameters:

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

Result: successful operation or error message


E-mail auto-responders

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
E-mail auto-responders

Function: emailresponder

Result: the list of elements

  • email - E-mail address.


Create. Change. Auto-responder parameters

Function: emailresponder.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 ("email" element of "emailresponder" function)
  • Result: object parameters list

Create an object:

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "yes".
    • elid - unique identifier ("email" element of "emailresponder" 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.
  • rtype - Action.
    If the send_mail value is selected the parameters are allowed to use: 'body','subject','file' and the parameters are denied: 'command'
  • command - Script.
  • subject - Subject.
  • body - Message .
  • file - File.


Delete e-mail auto-responders

Function: emailresponder.delete

Parameters:

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

Result: successful operation or error message


Mailing lists

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
Mailing lists

Function: maillist

Result: the list of elements

  • name - Name.
  • owner - Administrator .
  • count - Number of subscribers.


Create. Change. Edit the mailing list properties

Function: maillist.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 "maillist" 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.
  • policy - Policy.
  • owner - Administrator .
  • password - Password.
  • maxlen - Maximum message size .
  • prefix - Prefix to the subject .
  • info - Information .
  • anonymous - Anonymous. (Optional parameter. To enable the option click "on".)


Delete the selected mailing lists

Function: maillist.delete

Parameters:

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

Result: successful operation or error message


Mailing list subscribers

Function: maillist.subscriber

Parameters:

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

Result: elements list

  • name - Address.


Create. Change. Edit the subscriber's e-mail address

Function: maillist.subscriber.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 "maillist" function).
    • elid - unique identifier ("name" element of "maillist.subscriber" 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 "maillist" 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 "maillist" function).
    • elid - unique identifier ("name" element of "maillist.subscriber" function)
    • additional query parameters ...
  • Result: successfull operation or error message

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

  • name - E-mail address .


Delete the selected subscribers

Function: maillist.subscriber.delete

Parameters:

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

Result: successful operation or error message


Mailing list senders

Function: maillist.sender

Parameters:

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

Result: elements list

  • name - Address.


Create. Change. Edit the senders' e-mail address

Function: maillist.sender.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 "maillist" function).
    • elid - unique identifier ("name" element of "maillist.sender" 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 "maillist" 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 "maillist" function).
    • elid - unique identifier ("name" element of "maillist.sender" function)
    • additional query parameters ...
  • Result: successfull operation or error message

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

  • name - E-mail address .


Delete the selected senders

Function: maillist.sender.delete

Parameters:

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

Result: successful operation or error message


Management Tools

Web scripts (APS)

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
Web scripts (APS)

Function: webaps

Result: the list of elements

  • key - The list element unique identifier
  • name - Name .
  • version - Version .
  • domain - Domain .
  • path - Path .


Web-scripts (APS)

Function: webaps.collection

Result: the list of elements

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


Adding a web-script . View. Change

Function: webaps.collection.add

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

  • path - Path to the archive .


Install the web-script . View. Change

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 .


APS web-script information . View. Change

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


Access privileges to the web-script

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
If the allow_partial value is selected the parameters are allowed to use: 'userlist'
If the deny_partial value is selected the parameters are allowed to use: 'userlist'
  • userlist - User list . (One or more values space-delimited)


Web-script collection update . View. Change

Function: webaps.collection.update

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


Delete the installed web-script

Function: webaps.delete

Parameters:

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

Result: successful operation or error message


Maintenance

Back up files

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
User file backups . View. Change

Function: backuponeclick

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

  • destdir - Backup directory .


Server Statistics

Disk usage

Image:isp_lite.png Image:isp_pro.png Image:isp_cluster.png
Disk usage

Function: diskusage

Result: the list of elements

  • name - Directory or file name.
  • size - Size (MB).


Delete the selected file or directory

Function: diskusage.delete

Parameters:

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

Result: successful operation or error message


System resources

Usage of system resources

Function: usersystemresources

Result: the list of elements

  • 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. View. Change

Function: usersystemresources.edit

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

  • period - Period.


  • Use the "featurelist" API function to get the list of active features.
Retrieved from "http://en.ispdoc.com/index.php/ISPmanager_API/User_(siteadmin)"
Was this helpful? Yes | No
Personal tools