COREmanager API

From ISPWiki
Jump to: navigation, search

On this page you can see automatically generated description of panel’s functions and their parameters.

For more information on how to work with API and call its functions, please refer to the article Working_with_ISPsystem's_API.

This page is generated automatically, that’s why the information it contains may vary depending on configuration. You can find a certain function or parameter name in the control panel’s configuration file by executing the function in the web-interface.

Function name and its parameters will be shown in the log.== Log ==

Function: gdpr_journal

Result: the list of elements

Log

Access level: admin+

  • action_object - Object
  • doc_name - Document name
  • username - User
  • action_type - Action
  • ip - IP address


  • action_date - Action date

Contents

Set filter.

gdpr_journal.filter

IP pool

Function: ipmgr2

Result: the list of elements

IP pool

Access level: admin+

  • name - Pool name
  • note - Notes
  • usage - IP usage

IP pool:

Function: ipmgr2.edit

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

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

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

  • name - Pool name. A pool name allows an application to choose a range for allocating an IP address
  • note - Notes. Provide description for the pool of IP addresses

Set filter.

ipmgr2.filter

Delete

Function: ipmgr2.delete

Delete

Access level: admin+

Parameters:

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

Result: successful operation or error message

IP range

Function: ipmgr2.ranges

Result: the list of elements

IP ranges

Access level: admin+

  • id - Id
  • name - IP range
  • usage - IP usage

Delete the range. IP addresses allocated for this pool from the range, won't be modified

Function: ipmgr2.ranges.delete

Delete the range. IP addresses allocated for this pool from the range, won't be modified

Access level: admin+

Parameters:

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

Result: successful operation or error message

Address

Function: ipmgr2.ranges.ip

Result: the list of elements

Allocated IP addresses

Access level: admin+

  • name - Address
  • size - Number of IP addresses
  • domain - Domain name
  • status - Status
  • pool - IP pool
  • note -
Release

Function: ipmgr2.net.ip.delete


Access level: admin+

Parameters:

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

Result: successful operation or error message

Set filter.

ipmgr2.ranges.ip.filter

View the history

Function: ipmgr2.net.ip.history

View the history

Access level: admin+

Edit the selected IP address

Function: ipmgr2.net.ip.edit

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (id element of ipmgr2.ranges function).
    • elid - unique identifier (name element of ipmgr2.ranges.ip function)
  • Result: object parameters list

Create an object:

Parameters:

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

Change an object:

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

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

  • name - Address . IP address
  • domain - Domain name. Reverse domain name (PTR)
  • locked - . (Optional parameter. To enable the option click "on".) "Locked" IP addresses can be deleted or allocated. This assists in avoiding wrong operations performed by administrators or robots and allows to preserve system stability
  • note - Notes. Enter any information
Set filter.

ipmgr2.net.ip.filter

Edit the range of IP addresses

Function: ipmgr2.ranges.edit

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (name element of ipmgr2 function).
    • elid - unique identifier (id element of ipmgr2.ranges function)
  • Result: object parameters list

Create an object:

Parameters:

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

Change an object:

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

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

  • name - IP range. Enter a range of IP addresses that can be used for this pool. Enter a single address (123.45.67.89), a range (12.34.56.78-12.34.56.89) or a mask (12.34.56.0/26). You can enter any range (0.0.0.0/0 - all IPv4), but only those ranges that are specified in the list of physical networks, will be accepted. For IPv6 you can enter only a mask (fe80::/64). The maximum prefix size is /64.
  • createnet - . (Optional parameter. To enable the option click "on".) Check the box to automatically create a record in the list of physical networks
  • gateway - Gateway . Enter a gateway address. Usually, this is the same address as the primary IP.

Set filter.

ipmgr2.ranges.filter

Background tasks

Function: longtask

Result: the list of elements

Background tasks

Access level: admin+

  • manager - Control panel
  • queue - Queue name
  • realname - Script name
  • id - Identifier
  • created - Add time
  • startdate - Start time
  • enddate - End time
  • pidfile - PID-file
  • state - Status

Set filter.

longtask.filter

Delete the selected task. If the task is already running, it will be killed.

Function: longtask.delete

Delete the selected task. If the task is already running, it will be killed.

Access level: admin+

Parameters:

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

Result: successful operation or error message

Background task

Function: longtask.edit

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

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

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

  • manager - Control panel. Short name of the control panel that run the task
  • queue - Queue name. Name of the queue with this task
  • realname - Script name . Name of the script or executable file
  • id - Identifier . Task unique identifier. Usually, it contains the main parameters of a task
  • created - Add time. Time when this task was put into the queue
  • startdate - Start time. Start time
  • enddate - End time. End time
  • pidfile - PID-file. Path to the PID-file
  • depends - Dependencies . The current task depends on the tasks listed here
  • params - Additional information . List of task parameters
  • result - Result . Contents of stdout and errors

DNSBL

Function: ipmgr2.dnsbl

Result: the list of elements

Black lists

Access level: admin+

  • name - Black list address

Rename

Function: ipmgr2.dnsbl.edit

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

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

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

  • name - Black list address. Enter a domain name of the black list. This name will be used for IP address check

Disable the selected black list

Function: ipmgr2.dnsbl.delete

Disable the selected black list

Access level: admin+

Parameters:

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

Result: successful operation or error message

Access to functions

Function: userrights.group

Result: the list of elements

Functions access

Access level: admin+

  • name - Name
  • level - User role
  • users - Number of users
  • desc - Description

Delete the selected groups

Function: userrights.group.delete

Delete the selected groups

Access level: admin+

Parameters:

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

Result: successful operation or error message

User permissions

Function: userrights

Result: the list of elements

Privileges

Access level: admin+

  • caption - Name
  • access - User role

Restrict access to list elements

Function: userrights.filter

Restrict access to list elements

Access level: admin+

Default settings. Access permissions set for the selected user/group including permissions on columns and rows (if it is a list or form) will be deleted

Function: userrights.delete

Default settings. Access permissions set for the selected user/group including permissions on columns and rows (if it is a list or form) will be deleted

Access level: admin+

Parameters:

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

Result: successful operation or error message

Name

Function: userrights.fields

Result: the list of elements

List of fields (columns)

Access level: admin+

  • caption - Name
  • access - User role
Resume

Function: userrights.fields.resume

Resume

Access level: admin+

Parameters:

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

Result: successful operation or error message

Default settings. Access permissions set for the selected user/group including permissions on columns and rows (if it is a list or form) will be deleted

Function: userrights.fields.delete

Default settings. Access permissions set for the selected user/group including permissions on columns and rows (if it is a list or form) will be deleted

Access level: admin+

Parameters:

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

Result: successful operation or error message

Suspend

Function: userrights.fields.suspend

Suspend

Access level: admin+

Parameters:

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

Result: successful operation or error message

Field privileges

Function: userrights.fields.edit

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (name element of userrights function).
    • elid - unique identifier (name element of userrights.fields function)
  • Result: object parameters list

Create an object:

Parameters:

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

Change an object:

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

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

  • inhereted - . (Optional parameter. To enable the option click "on".) Do not set field permissions. They will be taken from groups to which this user is assigned
  • read - . (Optional parameter. To enable the option click "on".) Allow reading the field
  • write - . (Optional parameter. To enable the option click "on".) Allow editing the field
  • new - . (Optional parameter. To enable the option click "on".) Allow editing the form while creating an object

Access to functions

Function: userrights.edit

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (key element of userrights.group function).
    • elid - unique identifier (name element of userrights function)
  • Result: object parameters list

Create an object:

Parameters:

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

Change an object:

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

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

  • inhereted - . (Optional parameter. To enable the option click "on".) Do not set permissions. The will be based on other billing policies
  • access - User role . Set access permissions to this function
  • inherit - . (Optional parameter. To enable the option click "on".) Apply the access permissions to all of the group functions

Policy

Function: userrights.policy

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (key element of userrights.group function).
    • elid - unique identifier (name element of userrights function)
  • Result: object parameters list

Create an object:

Parameters:

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

Change an object:

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

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

  • policy - Default policy settings. Set the user access permissions to the functions. Changing this value will reset the current access permissions. If the user is assigned into any group, the group settings will have higher priority

Resume

Function: userrights.resume

Resume

Access level: admin+

Parameters:

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

Result: successful operation or error message

Suspend

Function: userrights.suspend

Suspend

Access level: admin+

Parameters:

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

Result: successful operation or error message

Group

Function: userrights.group.edit

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • elid - unique identifier (key element of userrights.group function)
  • Result: object parameters list

Create an object:

Change an object:

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

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

  • level - User role. Select access level for which settings of the new group will be applied. Access level defines modules that will display in the interface menu once group privileges are set. It cannot be modified
  • name - Name. You may change the name of the group. It will not affect user privileges assigned to that group
  • default - . (Optional parameter. To enable the option click "on".) Privileges set for this group will be automatically applied for all the users with similar access level
  • user - User. Select a user who will be used for collecting data specific for the selected access level, i.e. list of modules available for editing will be generated based on the modules avaiable to this user.

Fields in forms and lists may differ for users with the same access level. Make sure you choose a right use

  • _desc - .
  • policy - Default . By default

Name

Function: userrights.group.users

Result: the list of elements

User groups

Access level: admin+

  • name - Name
  • status - Status

Resume

Function: userrights.group.users.resume

Resume

Access level: admin+

Parameters:

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

Result: successful operation or error message

Suspend

Function: userrights.group.users.suspend

Suspend

Access level: admin+

Parameters:

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

Result: successful operation or error message

File manager

Function: file

Result: the list of elements

File manager

Access level: user super

  • dname - Name
  • size - Size
  • attr - Attributes
  • user - Owner
  • group - Group
  • time - Change date

Download the selected file(s).

Function: file.download

Download the selected file(s).

Access level: user super

Scan the selected file or directory for viruses.

Function: file.avcheckparams

Scan the selected file or directory for viruses.

Access level: user super

Inventory module settings

Function: file.upload

Access level: user super

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

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

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

  • type - Upload type. Select the upload type you want to use. You can upload files from your local computer or from a remote server. The files will be stored into the current folder.
  • name - File name. Enter the name of the file you want to upload. If you leave this field blank, the file name will be extracted from the URL.

Delete the selected file or directory.

Function: file.delete

Delete the selected file or directory.

Access level: user super

Parameters:

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

Result: successful operation or error message

Inventory module settings

Function: file.search

Access level: user super

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

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

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

  • search_type - Mode. Begin new search or view previous results. Previous search results are available if you made the search earlier and temporary file with results are still available
  • mask_filename - Mask name. Enter a a sequence of symbols to search for files. You can use the '*' and '?' symbols
  • opt_subdir - Search in subdirectories . (Optional parameter. To enable the option click "on".) Select this option to beging your search in all subdirectories of this directory
  • opt_filecontent - Search by content . (Optional parameter. To enable the option click "on".) Select this option to begin your search by file content. Please note: this operation may take much system resources
  • mask_filecontent - Content filter. Enter a part of the string or regular expression to search by file contents. For example, a regular expression can begin with '*' (indicating start of a new line), and end with '$' (indicating end of line)
  • encoding - Encoding . The mask will be encoded in the selected encoding
  • dir_prev - Directory . Name of the folder where the search was done.
  • mask_filename_prev - Searched for. Word(s) used to search for.
  • opt_subdir_prev - . (Optional parameter. To enable the option click "on".) The search was also done in the subfolders of the entered folder.
  • opt_filecontent_prev - . (Optional parameter. To enable the option click "on".) The search was also done on the content of the files.
  • mask_filecontent_prev - Content mask . Mask that was used for search
  • encoding_prev - Encoding . Search by content will be made in the selected encoding

Attributes

Function: file.unixattr

Access level: user super

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

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

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

  • dname - Name. Enter the name of the file or folder.
  • dest - Refer to. Enter the value for the symlink
  • uid - Owner. Select the username who owns this file or folder.
  • gid - Group. Select the user group who owns this file or folder.
  • recursive - Change child elements. Select how you want to apply the changes for child elements if the selected directory(ies)
  • mode - Permissions. Enter the file or folder permissions as a binary mask. You can also use the checkboxes underneath this field to set the permissions.
  • pur - . (Optional parameter. To enable the option click "on".) Check the boxes to set the owner permissions (read, write and execute).
  • puw - . (Optional parameter. To enable the option click "on".)
  • pux - . (Optional parameter. To enable the option click "on".)
  • pgr - . (Optional parameter. To enable the option click "on".) Check the boxes to set the group permissions (read, write and execute).
  • pgw - . (Optional parameter. To enable the option click "on".)
  • pgx - . (Optional parameter. To enable the option click "on".)
  • por - . (Optional parameter. To enable the option click "on".) Check the boxes to set the permissions for everyone who is not the owner and is not assigned to the group (read, write and execute).
  • pow - . (Optional parameter. To enable the option click "on".)
  • pox - . (Optional parameter. To enable the option click "on".)

Password protect the WWW-domain's directories

Function: file.diraccess

Password protect the WWW-domain's directories

Access level: user super

Copy

Function: file.copyto

Access level: user super

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

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

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

  • move - Move files. (Optional parameter. To enable the option click "on".) Check the box to move the file(s) to the folder you have selected above.

In this case, the files are moved to the specified folder and no copies will be made.

  • overwrite - Overwrite. (Optional parameter. To enable the option click "on".) Check the box to allow to overwrite files when the target folder already has a file with the same name.
  • goto - Open the selected directory. (Optional parameter. To enable the option click "on".) Check the box to open the selected folder after the files are copied or moved.

Inventory module settings

Function: file.settings

Access level: user super

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

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

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

  • editor_codepage - File editor code page. Select a code page to open files in the editor
  • editor_rows - Records in file editor. Select the approximate height of the file editor window in lines. Possible values 5 to 100. Actual number of lines in the window may vary depending on the font size selected
  • default_arc - Default archiver. Select an archiver that will be used when uploading directory or group of files

Create file or directory

Function: file.new

Access level: user super

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

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

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

  • filetype - Type. Select the file type that you want to create. You can create a file, a folder or a symlink.
  • name - Name. Enter the name of the file, foler or symlink.
  • dest - Value. Enter the name of the file or folder that this symlink will point to.

Go to directory

Function: file.folder

Access level: user super

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

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

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

Edit file

Function: file.edit

Access level: user super

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

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

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

  • full_filepath - File name. Full path to the file. This path is relative to your home directory.
  • encoding - Encoding. Select file encoding that will be used by the file editor. Warning: changing encoding will reopen the file editor and unsaved changes will tbe lost!
  • rowcount - Number of rows displayed . Enter the number of lines to display
  • fdata - .
  • savetime - Saved in . In this field you can see the file save time. Server time is specified here

Archive

Function: file.pack

Access level: user super

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

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

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

  • filetype - Type. Select an archive type
  • arcname - Archive name. Enter the name for the new archive (without extension)
  • remove_files - Delete files. (Optional parameter. To enable the option click "on".) Select the check box to delete the selected files (directories) once they are archived

Extract archive(s)

Function: file.extract

Access level: user super

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

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

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

  • newdir - Create a directory. In this field you can enter any directory for extracting archive related to the one from the tree. If the specified subdirectory does not exist, it will be created
  • goto - Open the selected directory. (Optional parameter. To enable the option click "on".) The selected directory will open by default once the operation is complete

Terms of use

Function: gdpr_docs

Result: the list of elements

Terms of use

Access level: admin+

  • id - Id
  • name - Document name
  • locale - Localization
  • entry_date - Effective date
  • change_date - Change date
  • status - Status

View the history

Function: gdpr_docs.history

View the history

Access level: admin+

Terms of use

Function: gdpr_docs.edit

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

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

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

  • type - Condition type. Select a condition type
  • name - Document name. Enter the document name
  • url - Document URL. URL to the web-site where the document is located
  • desc_condition - Condition description. Description of the conditions
  • entry_date - Effective date. Document effective date
  • locale - Localization. Document localization
  • need_agree - . (Optional parameter. To enable the option click "on".) Clients must accept terms of the document
  • show_after_auth - . (Optional parameter. To enable the option click "on".) Display the document after login
  • show_in_warnings - . (Optional parameter. To enable the option click "on".) Display links in warnings

Resume

Function: gdpr_docs.resume

Resume

Access level: admin+

Parameters:

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

Result: successful operation or error message

Suspend

Function: gdpr_docs.suspend

Suspend

Access level: admin+

Parameters:

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

Result: successful operation or error message

Set filter.

gdpr_docs.filter

Physical networks

Function: ipmgr2.net

Result: the list of elements

Physical networks

Access level: admin+

  • name - Network
  • note - Notes
  • netmask - Network mask
  • gateway - Gateway
  • usage - IP usage

Address

Function: ipmgr2.net.ip

Result: the list of elements

Allocated IP addresses

Access level: admin+

  • name - Address
  • size - Number of IP addresses
  • domain - Domain name
  • status - Status
  • pool - IP pool
  • note -

Edit networks

Function: ipmgr2.net.edit

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

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

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

  • name - Network. Enter a network (12.34.56.0/24 or 2a01:1::/48 for IPv6). For more information, please refer to the Documentation
  • gateway - Gateway. Enter a gateway address. It is used by other software products for network configuration.
  • firstip - First IP. Enter the first IP address in the selected network
  • lastip - Lats IP. The last IP address in the selected network
  • ipcount - Number of IP addresses. Number of IP addresses in the selected network
  • note - Notes. Enter any information about the selected network

Delete

Function: ipmgr2.net.delete

Delete

Access level: admin+

Parameters:

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

Result: successful operation or error message

Set filter.

ipmgr2.net.filter

User settings

Function: usrparam

Access level: admin+

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

View data:

  • Result: <a href="api#param">parameters list</a>

Change the data:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

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

  • name - Username. The username that must be used to access the control panel. You can not change the username.
  • theme - Theme. Select the theme that will be used to display the control panel
  • lang - Language. Select a language that will be used in the control panel. ISPsystem company has translated the software products into English and other languages with the help of its partners, and the translation is not guaranteed to be 100% correct. The program may contain texts which are currently under translation. If you found a typo, select it press Ctrl+Enter to correct it
  • old_password - Old password. You need to enter the old password if you want to change the password
  • password - Password. Enter a password to access the control panel. If you you do not want to change the password, leave this field blank
  • confirm - Re-enter password. Re-enter the password to ensure it is correct.
  • atype - Access to control panel. Enter the IP addresses that can be used to access the control panel. Please note: if you make mistakes here, it could be possible that you are not able to log in into the control panel anymore.
  • addr - List of IP addresses. Enter the IP addresses that will be allowed to access the control panel. You can enter a single IP address (123.45.67.89), a mask (123.45.67.0/24) or a range of addresses (123.45.67.89-123.45.67.98).
  • secureip - . (Optional parameter. To enable the option click "on".) A user will be granted with the unique session identifier after registration. By default, it can be used from any IP address. Check the box to allow using the session only from the IP address that was used when the user obtained it
  • startpage - Start page. Select the page that will shown after you logged in into the control panel.
  • rows - Rows per page. Enter he number of rows that will be displayed on a page by default.
  • recordlimit - Number of records. Enter the maximum number of records that are shown in tables. Reducing the number of records will speed up the creation of the tables.
  • buttonview - Toolbar view. Select the way icons will be displayed on the toolbar: icons with text or icons only.
  • hintview - Hints. Active hints are shown when moving a mouse cursor over the input field. Passive hints are displayed only when moving the mouse cursor over the hint sign.
  • checkunsaved - . (Optional parameter. To enable the option click "on".) Check the box to get a warning when you close a page where you have made modifications to the settings of a module that are not saved.
  • email - E-mail for notifications. Enter the email address that will be used for system notifications
  • page_actions - Page.
  • vkontakte_status - . (Optional parameter. To enable the option click "on".) Link this account to your Vkontakte account. To untie it, you need to clear the check box and close the form
  • facebook_status - . (Optional parameter. To enable the option click "on".) Link this account to your Facebook account. To untie it, you need to clear the check box and close the form
  • google_status - . (Optional parameter. To enable the option click "on".) Link this account to your Google account. To untie it, you need to clear the check box and close the form


  • disable_totp - Disable two-factor authentication. To disable two-factor authentication, enter a six-digit code generated by Google Authenticator

SSL-keys

Function: sslkey

Result: the list of elements

SSL-keys

Access level: registered

  • server - Panel URL
  • user - User
  • cert - Certificate
  • start - Creation date
  • expire - Expiry date
  • props - Properties

You can download the key. This operation can be run only once. The key file will be deleted upon downlaod

Function: sslkey.download

You can download the key. This operation can be run only once. The key file will be deleted upon downlaod

Access level: registered

New SSL key

Function: sslkey.edit

Access level: registered

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 "ok".
    • elid - unique identifier (key element of sslkey function)
    • additional query parameters ...
  • Result: successful operation or error message

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

  • server - Panel URL. Different panel's addresses can use different SSL certificates for authentication. A new key will be valid only for the certificate used on this port
  • self - . (Optional parameter. To enable the option click "on".) You can create a key for the current user or for any of his users
  • username - Username. Enter the user for whom you want to generate a key. You must be the owner of that user
  • type - Action. You can generate a new key, use the existing one, use the current key (if you used the key that is not registered in the system) or get a signed certificate to generate the key manually
  • name - Key name. Enter a name for the certificate that will be shown in the system
  • period - Validity period (days). A new key will be valid during the specified period starting today
  • passwd - . Enter a password for the SSL key
  • confirm - Re-enter password.
  • subject - Key name. Enter the name of your key. Note: the key must be signed by the certificate specified in the HTTP server settings.
  • request - SSL certificate request. You will get a signed certificate. To generate a key, convert it into PKCS#12 format. For example, you can use the command: openssl pkcs12 -export -in my.crt -inkey my.key -certfile ca.crt -out my.p12 -passout pass:your password

Delete

Function: sslkey.delete

Delete

Access level: registered

Parameters:

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

Result: successful operation or error message

System configuration

Function: srvparam

Access level: admin+

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

View data:

  • Result: <a href="api#param">parameters list</a>

Change the data:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

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

  • srvname - Server name. Hostname is a server's domain name. It should look like domain.com, otherwise some applications may malfunction
  • timezone - Time zone. The time zone in which the server has been configured
  • region - Region. The region where this time zone is located


  • location - Location . Geographic location
  • autoupdate - Update software automatically. COREmanager and the control panels are provided as OS packages. If you want to use the latest version available, you need to regularly update all the packages that you are using. You can seleсt whether you want to update only ISPsystem's products, or all system packages
  • ispaccess - . (Optional parameter. To enable the option click "on".) Select this check box to grant the ISPsystem's support staff access to your server
  • supportaccess - . (Optional parameter. To enable the option click "on".) Select the check box to allow technical support staff of your hosting provider to access the server
  • def_theme - Default interface theme.
  • pwstrength - Password strength. Don't use weak passwords for security reasons. Selecting this check box will forbid weak passwords. An attempt to set a weak password will fail and the corresponding error message witll be displayed
  • socnetwork - . (Optional parameter. To enable the option click "on".) Allows to sign on using existing login information from a social networking service
  • servertype - Mail server type . Select a type of the mail server that will send email notifications
  • smtpserver - SMTP-server address . Enter the SMTP server's address to send notifications
  • smtpuser - Account . Enter a username (full email address, such as example@mail.com)
  • smtppassword - Password. Enter a password
  • smtpport - SMTP-server port . Enter the SMTP-server port. Port 25 is used by default
  • sendername - Sender name . Enter the sender name that will be added to emails by default
  • expirejournaldays - Keep the log, days . Enter the period in days to keep records in the operation log
  • expirelogdays - Keep logs, days . Enter the number of days to keep the system logs

Problem IP

Function: ipmgr2.badip

Result: the list of elements

Problem IP addresses

Access level: admin+

  • ip - IP address
  • problem - Problem description
  • deletetime - When a problem occurs

Unblock IP addresses

Function: ipmgr2.badip.delete

Unblock IP addresses

Access level: admin+

Parameters:

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

Result: successful operation or error message

Edit

Function: net.addr.edit

Edit

Access level: admin+

Execute command

Function: test.runcommand

Access level: registered

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

View data:

  • Result: <a href="api#param">parameters list</a>

Change the data:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

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

  • command - Command. Run this command from the console
  • chose_macros - Command macro. Select a macro that will change value in the command
  • output - Result. Command result
  • mustbe - Contains lines. Enter the strings that should contain a result in the order as they appear in the command output. Use the word wrap as a new line separator
  • chose_macros_mustbe - Macro in Contains lines. Select a macro that will change value in the command output
  • randorder - . (Optional parameter. To enable the option click "on".) Search records in the command output randomly
  • notbe - Does not contain lines. Strings that should not contain a result. Use word wrap as a new line separator
  • chose_macros_notbe - Macro in Does not contain lines. Select a macro that will change value that is not present in the command output

Test scenario

Function: test

Result: the list of elements

Test scenarios

Access level: registered

  • number - Number
  • created - Creation time
  • name - Name
  • desc - Description
  • author - Author
  • panelname - Panel name
  • branch - Branch
  • bug - Bug number
  • runtype - Type
  • dependencies - Dependencies
  • ready - Parameters

Set filter.

test.filter

Settings

Function: test.settings

Access level: registered

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 "ok".
    • elid - unique identifier (id element of test function)
    • additional query parameters ...
  • Result: successful operation or error message

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

  • username - Username. Username
  • password - Password. Password
  • not_accept - . (Optional parameter. To enable the option click "on".) Only upload tests to the storage

Run test on remote panel

Function: test.dependency

Access level: registered

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 "ok".
    • elid - unique identifier (id element of test function)
    • additional query parameters ...
  • Result: successful operation or error message

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

  • url - Panel URL. URL to the remote panel
  • username - Username. Enter a username on the remote panel
  • password - Password. Password
  • useexisting - . (Optional parameter. To enable the option click "on".) Show tests on the remote panel
  • new_test_name - Name. Enter the name of the new test on the remote panel
  • existing_test - Test. Existing test on the remote machine

Delete

Function: test.delete

Delete

Access level: registered

Parameters:

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

Result: successful operation or error message

Test languages management

Function: test.language

Access level: registered

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 "ok".
    • elid - unique identifier (id element of test function)
    • additional query parameters ...
  • Result: successful operation or error message

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

  • request_lang - Query language . Select a query language

Disable test for download

Function: test.suspend

Disable test for download

Access level: registered

Parameters:

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

Result: successful operation or error message

Name

Function: test.request

Result: the list of elements

List of test requests

Access level: registered

  • id - Order number
  • action - Function name
  • desc - Action description

Waiting for request

Function: test.request.waiter

Access level: registered

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 test function).
    • elid - unique identifier (id element of test.request function)
  • Result: object parameters list

Create an object:

Parameters:

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

Change an object:

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

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

  • waittime - Time, sec. Request result wait time. It can be used for commands and check. We do not recommend setting this value for modifying command

Macros

Function: test.request.macros

Access level: registered

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 test function).
    • elid - unique identifier (id element of test.request function)
  • Result: object parameters list

Create an object:

Parameters:

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

Change an object:

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

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

  • macros_list - Macros. Select a macro for the field
  • field - Field. A new value will be used in this field
  • value - Value. Default value for the field
  • name - Macro name. Select a macro or create a new one
  • delmacros - . (Optional parameter. To enable the option click "on".) Delete the selected macros
  • composite - . (Optional parameter. To enable the option click "on".) Composite macro enables to specify a value consisting of two parts: static and changeable by macro
  • composite_value - Macro value . Enter the composite macro

Edit step

Function: test.request.edit

Access level: registered

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 test function).
    • elid - unique identifier (id element of test.request function)
  • Result: object parameters list

Create an object:

Parameters:

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

Change an object:

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

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

  • checkvalue - Check value. Value that will be checked when running the test
  • checktype - Check type. Select a check type
  • macro_in_string - String macro . Macro of the key field for string searching
  • test_query - Test query .
  • composite_elid - . (Optional parameter. To enable the option click "on".) Composite identifier is used for searching a string with the value to be checked
  • composite_elid_value - ID value. ID value with added macro
  • macros_value - Value macro . The check value will be changed into this macro

Run sequence of requests until the specified step (not included). If nothing is selected, all requests will be run

Function: test.request.runto

Run sequence of requests until the specified step (not included). If nothing is selected, all requests will be run

Access level: registered

Resume

Function: test.request.resume

Resume

Access level: registered

Parameters:

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

Result: successful operation or error message

Suspend

Function: test.request.suspend

Suspend

Access level: registered

Parameters:

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

Result: successful operation or error message

Delete

Function: test.request.delete

Delete

Access level: registered

Parameters:

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

Result: successful operation or error message

Inventory module settings

Function: test.edit

Access level: registered

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 "ok".
    • elid - unique identifier (id element of test function)
    • additional query parameters ...
  • Result: successful operation or error message

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

  • name - Name. Short description of the test scenario. The first modifying function will be automatically inserted when completed
  • desc - Description. Describe the main idea of this scenario
  • branch - Branch . Name of the branch where this test is running


  • bug - Bug number. Number of the bug from Bugzilla
  • needdelete - . (Optional parameter. To enable the option click "on".) Delete the created objects after finishing the test
  • runparams - Run type. Test will run in play mode
  • runos - Operating system . Run tests on the selected operating systems (on all OS if not otherwise specified)
  • ready - . (Optional parameter. To enable the option click "on".) This test can be uploaded to the server
  • environment - . (Optional parameter. To enable the option click "on".) Test that creates objects will start first and will delete object after completing the tests
  • dependency_test - Dependency . This test will depend on the selected test

Run test

Function: test.runmacros

Access level: registered

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 "ok".
    • elid - unique identifier (id element of test function)
    • additional query parameters ...
  • Result: successful operation or error message

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

  • usedefault - . (Optional parameter. To enable the option click "on".) Use the default values from the test

Synchronize test files with a remote storage

Function: test.synchronize

Synchronize test files with a remote storage

Access level: registered

Global variables

Function: test.globalvariables

Access level: registered

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 "ok".
    • elid - unique identifier (id element of test function)
    • additional query parameters ...
  • Result: successful operation or error message

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

Enable test for download

Function: test.resume

Enable test for download

Access level: registered

Parameters:

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

Result: successful operation or error message

Control panel address

Function: ihttpd

Result: the list of elements

Control panel address

Access level: admin+

  • port - IP address
  • props - Properties

Name

Function: ihttpd.certs

Result: the list of elements

Certificates for address

Access level: admin+

  • domain - Domain name
  • ip - IP-address
  • status - Status

Delete

Function: ihttpd.certs.delete

Delete

Access level: admin+

Parameters:

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

Result: successful operation or error message

Certificate for domains

Function: ihttpd.certs.edit

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (port element of ihttpd function).
    • elid - unique identifier (cert element of ihttpd.certs function)
  • Result: object parameters list

Create an object:

Parameters:

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

Change an object:

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

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

  • type - Certificate type . Please choose the method of creating certificate
  • domain - Domain name. Enter domain names which will be added to certificate. If you choose Let's Encrypt certificate, in order to finish the operation, you will need to confirm that you control this domain
  • ip - IP-address . IP-address of the panel
  • domain_ip - Domain IP-address . IP-address which the specified domain leads to
  • cert - SSL-certificate. Enter the SSL certificate that you want to use.
  • key - SSL-certificate key. Enter the key for your certificate
  • bundle - SSL-certificate chain. Enter the SSL certificate chain that will be added into the certificate file

Address

Function: ihttpd.edit

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

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

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

  • ip - IP address. Select the IP address to receive incoming connections
  • port - Port. Enter the port number for incoming connections. Leaving this field blank will apply the default value
  • sslonly - . (Optional parameter. To enable the option click "on".) The built-in web-server can receive both HTTP and HTTPS requests. If HTTP requests are forbidden, they will be automatically redirected to HTTPS.


  • ip_confirm - . (Optional parameter. To enable the option click "on".) Please, confirm that you want to delete all IP addresses that listen to the selected port

Delete

Function: ihttpd.delete

Delete

Access level: admin+

Parameters:

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

Result: successful operation or error message

Action log

Function: journal

Result: the list of elements

Action log

Access level: registered

  • time - Time
  • user - User
  • ip - Remote IP address
  • funcname - Function

Set filter.

journal.filter

Action log

Function: journal.edit

Access level: registered

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 "ok".
    • elid - unique identifier (id element of journal function)
    • additional query parameters ...
  • Result: successful operation or error message

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

  • time - Time. Time of execution of the action in the control panel
  • user - User. The user who has performed the action in the control panel
  • ip - Remote IP address . The IP-address from which the user has performed the operation in the control panel
  • funcname - Function. The name of the control panel's function
  • params - Paramaters. The list of the parameters transferred to the control panel's function

Name

Function: journal.stat

Result: report

Function usage over period

Access level: admin+

Inventory module settings

Function: ipmgr2.settings

Access level: admin+

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

View data:

  • Result: <a href="api#param">parameters list</a>

Change the data:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

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

  • type - Source type.
  • url - Server URL. Enter the URL of the remote control panel with a local pool of IP addresses
  • user - User. Enter a username to access IPmanager
  • secret - Password. Enter the password to log in to the control panel that will be used as a remote pool of IP addresses
  • password - Password. Enter a password to log in to the control panel
  • pool - IP pool. Select a pool of IP addresses that will be used by default
  • uselocal - . (Optional parameter. To enable the option click "on".) All IP addresses assigned to the server interface will be added into the pool and marked "available"
  • usedns - . (Optional parameter. To enable the option click "on".) Enter the URL of DNSmanager 5 where PTR will be created
  • dnsurl - Server URL. Enter the URL of DNSmanager 5 where PTR will be created
  • dnsuser - User. Enter a username to log in to DNSmanager
  • dnspass - Password. Enter a user password to log in to DNSmanager
  • domain - Domain name for service IP addresses. Enter a domain name that will be assigned to service IP addresses

Access log

Function: authlog

Result: the list of elements

Access log

Access level: registered

  • time - Time
  • user - User
  • ip - Remote IP address

Set filter.

authlog.filter

Notifications

Function: problems

Result: the list of elements

Notifications

Access level: admin+

  • id - Id
  • dateinit - Date
  • owner - User
  • type - Type
  • problem_id - Identifier
  • description - Description
  • properties - Properties
  • dateautosolve - Last attempt
  • autosolvecount - Attempts
  • sameproblemcount - Number
  • period - Period (min)

Notification module settings

Function: problems.settings

Access level: admin+

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 "ok".
    • elid - unique identifier (id element of problems function)
    • additional query parameters ...
  • Result: successful operation or error message

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

  • keep_old - Keep old notifications (days). Information about notifications that did not occur during a selected period, will be deleted automatically. The default value is 30 days
  • keep_solved - Keep resolved issues (days). Information about issues that were resolved this number of days ago, will be deleted automatically. The default value is one week
  • show_userproblems - . (Optional parameter. To enable the option click "on".) Select the check box to display users' notifications. The check box is not selected by default
  • notification_enabled - . (Optional parameter. To enable the option click "on".) Select the check box to send error notifications
  • smtpserver - SMTP-server . Enter the SMTP server for sending notifications
  • smtpport - SMTP-server port. Enter an SMTP port for sending notifications
  • address_to - Email for notifications . Enter an email address to which new notifications will be sent
  • address_from - Sent from . Enter an email address from which new notifications will be sent
  • plang - Notification message language. Select a language that will be used in notifications

Resolve the selected error message automatically.

Function: problems.solve

Resolve the selected error message automatically.

Access level: admin+

Parameters:

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

Result: successful operation or error message

Notification properties

Function: problems.edit

Access level: admin+

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 "ok".
    • elid - unique identifier (id element of problems function)
    • additional query parameters ...
  • Result: successful operation or error message

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

  • id - Id. Notification identifier
  • type - Notification type. Notification type
  • date_init - Date. Date when this notification appeared in the system for the last time
  • description_local - Description. Text description of the notification
  • level - Level. Select a notification level: message, warning, fatal error
  • autosolve - . (Optional parameter. To enable the option click "on".) Select the check box to try to resolve the problem automatically at specified period
  • autosolve_period - Period (min). Period in minutes that will pass before a new attempt to resolve the issue will be made
  • solvenow - . (Optional parameter. To enable the option click "on".) With this option selected, clicking OK will try to resolve this issue
  • params - Additional information. Additional information related to this problem

Delete the selected error message.

Function: problems.delete

Delete the selected error message.

Access level: admin+

Parameters:

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

Result: successful operation or error message

Name

Function: problems.log

Result: the list of elements

Log

Access level: admin+

  • date - Date
  • owner - User
  • duration - Duration

Set filter.

problems.filter

Scenario background tasks

Function: test.longtask

Result: the list of elements

Test background tasks

Access level: registered

  • id - Identifier
  • name - Name
  • queue - Queue name

Wait

Function: test.longtask.wait


Access level: registered

Parameters:

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

Result: successful operation or error message

Logging settings

Function: errorjournal.settings

Result: the list of elements

Logging settings

Access level: admin+

  • name - Description
  • module - Module
  • level - User role

Logging settings

Function: errorjournal.settings.edit

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • elid - unique identifier (module element of errorjournal.settings function)
  • Result: object parameters list

Create an object:

Change an object:

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

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

  • level - User role . You can change the amount of debugging information that will be written into the error log. The large the figure, the more detailed information will be logged

Delete logging settings for the selected module from the configuration file

Function: errorjournal.settings.default

Delete logging settings for the selected module from the configuration file

Access level: admin+

Parameters:

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

Result: successful operation or error message

Set the maximum logging settings for the selected module

Function: errorjournal.settings.setmax

Set the maximum logging settings for the selected module

Access level: admin+

Parameters:

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

Result: successful operation or error message

Branding settings

Function: brandlist

Result: the list of elements

Branding settings

Access level: admin+

  • manager - Control panel
  • domain - Domain name
  • theme - Interface theme
  • params - Parameters

Branding settings

Function: brandlist.edit

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

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

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

  • manager - Control panel. Select a control panel which interface view you want to change
  • domain_all - . (Optional parameter. To enable the option click "on".) The control panel view may differ depending on the domain name that you used
  • domain - Domain name. Enter the domain name. Interface settings will be applied only when accessing the panel via this name
  • h - Hue. Hue of the color scheme . Values from -180 to 180
  • s - Saturation. Color scheme saturation . Values from -100 to 100
  • l - Brightness. Color intensity . Values from -100 to 100
  • header - Window heading. This field will be used as the page heading
  • site - Logo URL. Enter the site address that will open when clicking the logo
  • signature - Copyright notice. Copyright notice. Normally it is specified as: the copyright sign, copyright holder and company working years
  • homepage - Home page. Enter the URL of the company's home page. You can use the $lang macro, which will be changed into a language code
  • contacts - Contacts. You can add a link to your company's contacts. The link will be shown in the Login form. You can use the $lang macro, which will be changed into a language code
  • head - Heading. This code will be added into the page heading (HEAD)
  • body - Body. This code will be added at the end of the page body (BODY)

Delete

Function: brandlist.delete

Delete

Access level: admin+

Parameters:

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

Result: successful operation or error message

Form the icons and css files for all the settings

Function: brandlist.fix

Form the icons and css files for all the settings

Access level: admin+

Slave servers

Function: slaveserver

Result: the list of elements

Slave name servers

Access level: registered

  • url - Control panel URL
  • username - User

Slave name server

Function: slaveserver.edit

Access level: registered

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

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

  • username - User. Enter a username to access the control panel on the slave server
  • password - Password. Enter a password to access the control panel on the slave server
  • sync - . (Optional parameter. To enable the option click "on".) Create the existing domain names on the slave server

Delete the selected slave name servers

Function: slaveserver.delete

Delete the selected slave name servers

Access level: registered

Parameters:

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

Result: successful operation or error message

System information

Function: sysinfo

Result: the list of elements

System information

Access level: admin+

  • name - Parameter
  • value - Value

View detailed information on the selected parameter

Function: sysinfo.seltype

View detailed information on the selected parameter

Access level: admin+

About program

Function: license.info

Access level: admin+

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

View data:

  • Result: <a href="api#param">parameters list</a>

Change the data:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

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

  • licid - License ID. License unique identifier. 0 means that you use a free version with certain limitations (they are described at the top of the toolbar)
  • licname - License name. Name of the control panel that you entered during the order process.
  • licdate - Expiration date. License expiry date. The license must be updated upon expiration.
  • updateexpiredate - Updates expiration date. Updates subscription expiration date
  • regemail - Registered to. Account address in ISPsystem billing system, which is used for registering the license
  • panel_name - Control panel. Name of control panel installed on server
  • os - Operating system. Operating system running on the web server where the control panel is installed
  • repository - Repository . Repository that is used for updates
  • mirror - Mirror. Mirror to upload data files
  • core_info - COREmanager version. COREmanager version and build date
  • panel_info - Control panel version. Version and release date
  • last_available_version - Latest version . The latest version available for download

Email notifications

Function: emailnotify

Access level: admin+

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

View data:

  • Result: <a href="api#param">parameters list</a>

Change the data:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

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

  • servertype - Mail server type . Select a type of the mail server that will send email notifications
  • smtpserver - SMTP-server . Enter the SMTP server URL to send notifications
  • smtpuser - Login. Enter a username (login or full email address, such as example@mail.com)
  • smtppassword - Password. Enter a password
  • smtpport - SMTP-server port. Enter the SMTP-server port. Port 25 is used by default
  • sendername - Sender name . Enter the sender name that will be added to emails by default
  • servername_param - Server name. Enter the domain name of the server that will be used in the email
  • type_auth - . (Optional parameter. To enable the option click "on".) Select the check box to allow notifications about successful authentication in the panel
  • type_geoip - . (Optional parameter. To enable the option click "on".) Select the check box to enable notifications from the geolocation module. Disabling this option will disable the GeoIP module
  • type_recovery - . (Optional parameter. To enable the option click "on".) Enable password reset notifications. Disabling this option will also disable the module itself
  • type_dnssec - . (Optional parameter. To enable the option click "on".) Allows sending DNSSEC dns-server extension notifications

Modules

Function: plugin

Access level: admin+

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

View data:

  • Result: <a href="api#param">parameters list</a>

Change the data:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

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

Change log

Function: changelog

Result: the list of elements

Change log

Access level: admin+

  • version - Version
  • date - Release date
  • install_date - Installation date
  • count - Number of changes
  • state - Status

Set filter.

changelog.filter

Update the list of versions

Function: changelog.refresh

Update the list of versions

Access level: admin+

Name

Function: changelog.changes

Result: the list of elements

Version changes

Access level: admin+

  • desc - Description
  • type - Type
  • edition - Product version

Re-build control panel

Function: builder.make

Access level: admin+

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

View data:

  • Result: <a href="api#param">parameters list</a>

Change the data:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

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

Active sessions

Function: session

Result: the list of elements

Active sessions

Access level: admin+

  • id - Session ID
  • name - User
  • props - User role
  • ip - IP address
  • idle - Idle
  • count - Current sessions

Log in to the control panel with the same access privileges

Function: session.su

Log in to the control panel with the same access privileges

Access level: admin+

Terminate the selected session(s). If you terminate a session the user must log in again

Function: session.delete

Terminate the selected session(s). If you terminate a session the user must log in again

Access level: admin+

Parameters:

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

Result: successful operation or error message

Set filter.

session.filter

IP-address pool

Function: ipdb

Result: the list of elements

IP-address pool

Access level: admin+

  • range - IP address range
  • iptype - IP address group
  • gateway - Gateway
  • netmask - Network mask

Set filter.

ipdb.filter

Delete the range

Function: ipdb.delete

Delete the range

Access level: admin+

Parameters:

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

Result: successful operation or error message

Range parameters

Function: ipdb.edit

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

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

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

  • range - IP range. The range of IP addresses - network_address/network_mask, first_address-last_address or a single address
  • netmask - Network mask . The network mask. It is used by other control panel for network settings
  • gateway - Gateway . Enter a gateway address. It is used by other software products for network configuration.
  • iptype - IP address group. Type of IP addresses that is used by this control panel

Name

Function: ipdb.addr

Result: the list of elements

IP addresses

Access level: admin+

  • ip - IP address
  • domain - Domain name
  • xtype - Address type

IP address

Function: ipdb.addr.edit

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid - parent list unique identifier (range element of ipdb function).
    • elid - unique identifier (ip element of ipdb.addr function)
  • Result: object parameters list

Create an object:

Parameters:

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

Change an object:

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

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

  • ip - IP address. The IP address which properties you are editing
  • domain - Domain name. The domain name associated with this IP address

Enter a special address

Function: ipdb.addr.delete

Enter a special address

Access level: admin+

Parameters:

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

Result: successful operation or error message

Special domain names

Function: ipdb.settings

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

Create an object:

Change an object:

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

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

  • specdomain - Domain name. Enter a domain name that will be added to the names of special addresses (gateway, broadcast, subnet). Special addresses are reserved automatically while creating the range

Integration with IPmanager

Function: ipmgr

Access level: admin+

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

View data:

  • Result: <a href="api#param">parameters list</a>

Change the data:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

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

  • useipmgr - . (Optional parameter. To enable the option click "on".) Configure integration with IPmanager, a centralized pool of IP addresses
  • url - IPmanager URL. Enter the URL to the IPmanager server
  • login - Username. Enter a username to access IPmanager
  • password - Password. Enter a user password to access IPmanager