IPmanager 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.== IP addresses ==

Function: ip

Result: the list of elements

IP address management

Access level: user

  • ip - IP address
  • domain - Domain name
  • iptype - IP-address group
  • note - Notes

Set filter.

ip.filter

IP address

Function: ip.edit

Access level: user

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

View object's parameters:

Create an object:

Change an object:

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

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

  • family - Family . Select a version of the IP address that is currently supported by the control panel. IPv4 and IPv6 addresses are currently supported. Addresses that are available to you are displayed here.
  • iptype - IP-address group. A group of IP addresses can be used to group IP address by VLAN, or according to purposes of their usage, etc.
  • prefnet - Preferred network . Enter a desired network if you need an IP address from a specific subnet
  • ip - IP address. Enter a desired IP address. You can select the source from which IP addresses will be allocated
  • domain - Domain name. Enter a domain name that this IP will be associated with. Do not forget to put the dot at the end of the name.
  • count - Number of IPs. Enter the number of IP addresses that will be allocated
  • subnet - . (Optional parameter. To enable the option click "on".) Allocate continuous range of IP addresses aligned on subnet boundaries
  • netmask - Network mask . Enter a network mask where this IP address is located
  • gateway - Gateway. Enter a gateway address to be used together with this IP address.
  • note - Notes. Enter additional information related to this IP address

Unassign the selected IP address

Function: ip.delete

Unassign the selected IP address

Access level: user

Parameters:

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

Result: successful operation or error message

IP address groups

Function: iptype

Result: the list of elements

IP address groups

Access level: admin

  • name - Name
  • note - Notes

Rename

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

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

  • name - Name. Enter the name of the IP address group
  • note - Notes. Enter additional information related to this IP address

Delete

Function: iptype.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 iptype function.

Result: successful operation or error message

Problem IP

Function: problem.stat

Result: the list of elements

Problem IP addresses

Access level: admin

  • ip - IP address
  • problem - Problem description
  • deletetime - Time of occurrence

Unblock IP addresses

Function: problem.stat.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 problem.stat function.

Result: successful operation or error message

IP address

Function: net.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:

Create an object:

Change an object:

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

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

  • name - IP address. The IP address which properties you are editing
  • domain - Domain name. Enter a domain name associated with the selected IP address. Do not forget to put the dot at the end of the name.
  • mgruser - Owner. Select a user to whom this IP address will be allocated
  • iptype - IP-address group. A group of IP addresses can be used to group IP address by VLAN, or according to purposes of their usage, etc.
  • locked - . (Optional parameter. To enable the option click "on".) "Protected" IP addresses cannot be deleted and allocated again. This is an additional protection from faulty actions by administrators or bots, aiming to preserve normal operation of your network
  • note - Notes. Enter additional information related to this IP address

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 - Creation 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 - Creation 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

Usage per user

Function: userstat

Result: report

IP address usage per user

Access level: admin

DNS server settings

Function: dnsparam

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

  • email - Administrator email . DNS administrator email. It is specified in SOA record of a newly created domain zone
  • ns - Name servers. Enter the name(s) of the name servers that will handle the DNS records for this domain.
  • freename - Free addresses . Domain name that will be associated with all free IP addresses
  • internaldomain - Special addresses. Domain name that will be used for special IP addresses when creating a network.
  • classless - . (Optional parameter. To enable the option click "on".) Select the check box to create classless reverse zones when creating IPv4 networks smaller than /24. Otherwise /24 reverse zones will be created..

Please note: the name server wont't pass classless reverse zones. Select this check box only if your provider is provided you with network smaller than /24. He must set up /24 zone on his side based on requirements described at https://tools.ietf.org/html/rfc2317

  • fix - . (Optional parameter. To enable the option click "on".) Select the check box to apply the changes. Otherwise these settings will be applied only to newly created domain zones.

Available networks

Function: networkinfo

Result: the list of elements

Available networks

Access level: user

  • name - Network
  • type - Type
  • netmask - Network mask
  • gateway - Gateway

DNS settings for managing remote DNSmanager

Function: remote_dns_params

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

  • remote_url - URL . Enter the URL to access remote DNSmanager
  • remote_user - Username. Enter a username to access remote DNSmanager
  • remote_password - Password. Enter a user password to access remote DNSmanager

Usage by group

Function: iptypestat

Result: report

IP address usage by group

Access level: admin user

IP allocation

Function: permstat

Result: the list of elements

Statistics on IP address allocation

Access level: admin

  • name - Range
  • perm - Permissions

Users

Function: user

Result: the list of elements

User management

Access level: root admin

  • name - Username
  • level - Access level
  • note - Notes

User parameters

Function: user.edit

Access level: admin root

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

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

  • name - Username. Enter a username to access the control panel
  • level - User role . Access level is defined by control panel's functions available to the user
  • passwd - Password. Enter a password to access the control panel
  • confirm - Re-enter password. Re-type the password to ensure it was entered correctly
  • note - Notes. Enter additional information related to this IP address

Set filter.

user.filter

Name

Function: user.perm

Result: the list of elements

Pool of IP addresses

Access level: root admin

  • range - Pool of IP addresses
  • iptype - IP-address group
  • prop - Properties

Unassign the selected IP addresses

Function: user.perm.delete

Unassign the selected IP addresses

Access level: root admin

Parameters:

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

Result: successful operation or error message

Assigned pool of IP addresses

Function: user.perm.edit

Access level: admin root

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 user function).
    • elid - unique identifier (range element of user.perm 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 user 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 user function).
    • elid - unique identifier (range element of user.perm function)
    • additional query parameters ...
  • Result: successfull operation or error message

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

  • range - Pool of IP addresses . Enter a pool of IP addresses that your user will have access to. You can enter a single IP (123.45.67.89), a mask (123.45.67.0/24) or a range of addresses (123.45.67.89-123.45.67.98).
  • noauto - . (Optional parameter. To enable the option click "on".) Do not use this range, if address is allocated automatically (address or network is not specified)

Switch to the User level

Function: su

Switch to the User level

Access level: root admin

Delete the selected users

Function: user.delete

Delete the selected users

Access level: root admin

Parameters:

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

Result: successful operation or error message

Error log

Function: errorjournal

Result: the list of elements

Error log

Access level: admin

  • date - Event date
  • funcname - Function
  • user - User
  • status - Status

Name

Function: errorjournal.coredumps

Result: the list of elements

Memory dump log

Access level: admin

  • date - Event date
  • corefile - Core dump file
  • status - Status

Delete the selected reports and dump

Function: errorjournal.coredumps.delete

Delete the selected reports and dump

Access level: admin

Parameters:

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

Result: successful operation or error message

Report

Function: errorjournal.coredumps.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 (date element of errorjournal function).
    • elid - unique identifier (repfile element of errorjournal.coredumps function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (date element of errorjournal 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 (date element of errorjournal function).
    • elid - unique identifier (repfile element of errorjournal.coredumps function)
    • additional query parameters ...
  • Result: successfull operation or error message

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

  • email - Email. Enter your contact email
  • drop - . (Optional parameter. To enable the option click "on".) Select the check box to delete the report after it is sent to developers
  • fsymbols - . Information from developers from the gdb debugger
  • fbacktrace - . Information from developers about application thread tracing

Error information

Function: errorjournal.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 (date element of errorjournal function)
    • additional query parameters ...
  • Result: successful operation or error message

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

  • email - Email. Enter your contact email
  • drop - . (Optional parameter. To enable the option click "on".) Select the check box to delete the report after it is sent to developers
  • frequest - .
  • flog - . Control panel logs at the moment the error occurred
  • fbacktrace - . Control panel trace before the error occurred
  • fdata - . Full report that will be sent to developers

Delete the selected reports

Function: errorjournal.delete

Delete the selected reports

Access level: admin

Parameters:

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

Result: successful operation or error message

Set filter.

errorjournal.filter

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:
    • plid - parent list unique identifier (date element of errorjournal function).
    • elid - unique identifier (module element of errorjournal.settings function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok - the parameter must not be empty, generally "ok".
    • plid - parent list unique identifier (date element of errorjournal 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 (date element of errorjournal function).
    • elid - unique identifier (module element of errorjournal.settings function)
    • additional query parameters ...
  • Result: successfull 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

User settings

Function: usrparam

Access level: admin user

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

Networks

Function: net

Result: the list of elements

Network management

Access level: admin

  • net - Network
  • note - Notes
  • usage - IP address usage

Name

Function: net.addr

Result: the list of elements

Network IP addresses

Access level: admin

  • ip - IP address
  • domain - Domain name
  • status - Status
  • mgruser - Owner
  • iptype - IP-address group
  • note - Notes

Unassign the selected IP addresses

Function: net.addr.delete

Unassign the selected IP addresses

Access level: admin

Parameters:

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

Result: successful operation or error message

Set filter.

net.addr.filter

View the history

Function: net.addr.history

View the history

Access level: admin

Network settings

Function: 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 (net element of net function)
    • additional query parameters ...
  • Result: successful operation or error message

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

  • net - Network . Enter the network in the format: 12.34.56.0/24 or 2a01:1::/48 for IPv6. For more details about configuration see the Documentation
  • gateway - Gateway. Enter a gateway address. It is used by other software products for network configuration.
  • firstip - First IP address. Enter the first IP address of the specified network
  • lastip - Last IP address . Enter the last IP address in the specified network
  • ipcount - Number of IP addresses . The number of IP addresses in the specified network
  • note - Notes. Enter additional information related to this IP address

Delete the selected networks

Function: net.delete

Delete the selected networks

Access level: admin

Parameters:

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

Result: successful operation or error message

Set filter.

net.filter

DNSBL blacklists

Function: dnsbl

Result: the list of elements

Blacklists

Access level: admin

  • name - Blacklist address

Rename

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

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

  • name - DNSBL address. Blacklisted domain name that is used to check IP addresses

Suspend the selected Blacklist

Function: dnsbl.delete

Suspend the selected Blacklist

Access level: admin

Parameters:

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

Result: successful operation or error message