DNSmanager API/Administrator

From ISPWiki

(Redirected from DNSmanager API)
Jump to: navigation, search

Contents

See also


Administrator

Main Features

Users

User management

Function: user

Result: the list of elements

  • name - Username.
  • owner - Owner.
  • level - .
  • disabled - The account and all its domains are disabled .
  • level_12 - Administrator .
  • level_11 - Reseller .
  • level_10 - User .
  • view - DNS name space.
  • domains - Domains. Attributes :
    • used - The used number.
    • limit - Max value limitation


Create. Change. User properties

Function: user.edit

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

View object's parameters:

Create an object:

Change an object:

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

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

  • name - Username.
  • level - Access level.
    If the admin value is selected the parameters are denied: 'view','ip','domlimit'
  • view - DNS name space.
  • ip - IP-address.
  • passwd - Password.
  • confirm - Confirm password .
  • domlimit - Domain limit.


Delete the selected users

Function: user.delete

Parameters:

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

Result: successful operation or error message


Enable the selected users

Function: user.enable

Parameters:

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

Result: successful operation or error message


Disable the selected users

Function: user.disable

Parameters:

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

Result: successful operation or error message


Switch to User panel

Function: user.su


Server Statistics

Current activity

Active sessions

Function: session

Result: the list of elements

  • id - Session id.
  • name - User name.
  • lv_12 - .
  • lv_11 - .
  • lv_10 - .
  • lv_7 - Server administrator.
  • lv_6 - Reseller.
  • lv_5 - User.
  • lv_4 - User with access to shell.
  • lv_3 - User with access to FTP.
  • lv_2 - Mailbox.
  • ip - IP-address.
  • idle - Idle.


Terminate the selected session(s)

Function: session.delete

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


Log in to the control panel with the same access privileges

Function: session.su


Action log

Action log

Function: journal

Result: the list of elements

  • id - The list element unique identifier
  • time - Time.
  • user - User.
  • ip - Remote IP-address.
  • funcname - Function.


Action log . View. Change

Function: journal.edit

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

View object's parameters:

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

Change an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "yes".
    • 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.
  • user - User.
  • ip - Remote IP-address.
  • funcname - Function.
  • params - Parameters.


Other Settings

Brand settings

Brand settings . View. Change

Function: brand

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

View data:

Change the data:

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

  • site - Link to your web site (e.g. http://my-hosting-company.com).
  • project - Link to your web site (e.g. http://my-hosting-company.com).
  • mainlogo - .
  • loginlogo - .
  • favicon - .
  • reset - Reset all the branding settings . (Optional parameter. To enable the option click "on".)
  • h - Hue .
  • s - Saturation .
  • l - Brightness .
  • headinclude - Add to HEAD.
  • customstring - Your copyright notice . (Optional parameter. To enable the option click "on".)
    Active parameter allows the use of the following parameters: 'customstringvalue'
Active parameter denies the following parameters: 'companyname','foundationyear'
  • customstringvalue - Copyright .
  • companyname - Company name .
  • foundationyear - Year of foundation .
  • companyurl - Web-site URL.
  • noaddlang - Remove the locale parameter from URL . (Optional parameter. To enable the option click "on".)


Plug-ins

Plug-ins

Function: plugin

Result: the list of elements

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


Plug-ins collection

Function: plugin.collection

Result: the list of elements

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


Plug-in installation . View. Change

Function: plugin.install

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

View object's parameters:

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

Change an object:

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

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

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


Plug-in . View. Change

Function: plugin.info

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

View object's parameters:

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

Change an object:

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

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

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


Plug-in . View. Change

Function: plugin.info

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

View object's parameters:

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

Change an object:

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

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

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


Plug-in update

Function: plugin.update


'

Function: plugin.delete

Parameters:

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

Result: successful operation or error message


Plug-in source

Function: plugin.source

Result: the list of elements

  • url - Source URL .


Create. Change. Plug-in source

Function: plugin.source.edit

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

View object's parameters:

  • Parameters:
    • elid - unique identifier ("url" element of "plugin.source" function)
  • Result: object parameters list

Create an object:

Change an object:

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

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

  • url - Source URL .


Delete the selected source

Function: plugin.source.delete

Parameters:

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

Result: successful operation or error message


Update the source information

Function: plugin.source.refresh

Parameters:

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

Result: successful operation or error message


Integration with IPmanager

Integration with IPmanager. View. Change

Function: ipmgr

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

View data:

Change the data:

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

  • server - URL to IPmanager .
  • user - Login .
  • passwd - Password .


IP-addresses

IP-addresses management

Function: iplist

Result: the list of elements

  • name - IP-address .
  • usedby - In use .
  • access - Access level .


Create. Change. Edit level of access for the selected IP-address

Function: iplist.edit

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

View object's parameters:

Create an object:

Change an object:

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

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

  • name - IP-addresses .
  • atype - Access level .
    If the allow value is selected the parameters are denied: 'memb'
If the deny value is selected the parameters are denied: 'memb'
If the denypartial value is selected the parameters are allowed to use: 'memb'
If the allowpartial value is selected the parameters are allowed to use: 'memb'
  • members - Resellers . (One or more values space-delimited)


Delete the selected IP-addressees

Function: iplist.delete

Parameters:

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

Result: successful operation or error message


Access to modules

Access to modules

Function: access

Result: the list of elements

  • name - Function name.
  • ftitle - Module name.
  • lv_12 - The module is available for administrators .
  • lv_11 - The module is available for resellers .
  • lv_10 - The module is available for users .
  • lv_7 - The module is available for server administrator .
  • lv_6 - The module is available for resellers .
  • lv_5 - The module is available for site administrators .
  • lv_4 - The module is available for shell users .
  • lv_3 - The module is available for FTP users .
  • lv_2 - The module is available for mail users .
  • status - Status.


Access to the module . View. Change

Function: access.edit

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

View object's parameters:

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

Change an object:

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

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

  • name - Module name.
  • ftype - Access type.

Possible values :

    • allow - Allowed for all
    • deny - Denied for all
    • allow_partial - Allowed for
    • deny_partial - Denied for
If the allow_partial value is selected the parameters are allowed to use: 'userlist'
If the deny_partial value is selected the parameters are allowed to use: 'userlist'
  • userlist - The list of users. (One or more values space-delimited)


Control panel settings

Control panel settings. View. Change

Function: usrparam

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

View data:

Change the data:

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

  • name - Username.
  • email - E-mail for notifications.
  • email - E-mail for notifications. The parameter may vary depending on feature billmgr.
  • changed - Theme.
  • theme - Theme.
  • lang - Language.
  • timezone - Time zone.
  • passwd - Password.
  • confirm - Confirm password .
  • atype - Access level .
    If the atany value is selected the parameters are denied: 'addr'
  • addr - Allowed IP-addresses . (One or more values space-delimited)
  • startpage - Start page.
  • rows - Lines per page.
  • recordlimit - Number of records .
  • buttonview - Toolbar view.
  • ticketsound - . (Optional parameter. To enable the option click "on".)
  • ticketnoconfirm - . (Optional parameter. To enable the option click "on".)
  • useavatar - . (Optional parameter. To enable the option click "on".)
    Active parameter allows the use of the following parameters: 'avatardfield','avatarfield','avatarview'
  • filename - .


Help

License

License. View. Change

Function: softinfo

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

View data:

Change the data:

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

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


Updates

Updates

Function: updatelist

Result: the list of elements

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


Version changes

Function: updatelist.changelog

Parameters:

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

Result: elements list

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


Roll back the selected version to . View. Change

Function: updatelist.restore

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

View object's parameters:

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

Change an object:

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

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


Customize update parameters. View. Change

Function: updatelist.settings

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

View data:

Change the data:

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

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


Start updating

Function: updatelist.updatenow


Wish list

Wish list

Function: wishlist

Result: the list of elements

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


Create. Change. Feature request

Function: wishlist.edit

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

View object's parameters:

Create an object:

Change an object:

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

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

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


Vote

Function: wishlist.vote

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


Refresh the wish list

Function: wishlist.refresh


Error log

Error log

Function: errorjournal

Result: the list of elements

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


Logging settings . View. Change

Function: errorjournal.settings

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

View data:

Change the data:

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

  • level - Logging level .


Error from . View. Change

Function: errorjournal.edit

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

View object's parameters:

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

Change an object:

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

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

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


Delete the selected reports

Function: errorjournal.delete

Parameters:

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

Result: successful operation or error message



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