DNSmanager 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.== Domain names ==

Function: domain

Result: the list of elements

Domain names management

Access level: reseller admin user

  • name - Domain name
  • user - Owner
  • dtype - Type
  • status - Status

Name

Function: domain.su


Log in with domain owner privileges

Access level: reseller admin user

Name

Function: domain.record

Result: the list of elements

DNS record types

Access level: reseller admin user

  • name - Name
  • ttl - TTL, sec
  • rtype - Type
  • value - Value
  • info - Additional information

Delete the selected record

Function: domain.record.delete

Delete the selected record

Access level: reseller admin user

Parameters:

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

Result: successful operation or error message

Domain record

Function: domain.record.edit

Access level: admin user reseller

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

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

  • name - Name. Enter a name (it should be a subdomain)
  • ttl - TTL . Time to live
  • rtype - Type. Select a record type. Values and additional parameters may vary based on the record type selected
  • ip - IP address. Enter an IP address that will be associated with the domain name you specified in the "Name" field
  • domain - Domain. Domain name
  • srvdomain - Domain. Domain name
  • priority - Priority. Specify a priority
  • weight - Weight. Weight
  • port - Port. Enter a port number
  • value - Value. Enter any text
  • email - Administrator email. Enter an email for the DNS administrator
  • caa_flags - Flags . 0 — allows, 128 — forbids a Certification Authority to issue certificates, if it doesn't define a tag
  • caa_tag - Tag . issue — add domain name to allow a Certification authority (CA) to issue certificates

    issuewild — add CA domain to allow it issue wildcard certificates

    iodef — enter Email or URL of the page for feedback
  • caa_value_domain - Value. Domain name that will allow or ";" forbid Certification Authorities to issue certificates
  • caa_value_email - Value. Email or URL of the page for feedback
  • ds_key_tag - Key tag. Key identifier
  • ds_algorithm - Algorithm. Encryption key used in DNSSEC key
  • ds_digest_type - Digest type. Algorithm used to receive digest of key open part
  • ds_digest - Digest. Digest is provided as a set of hexadecimal symbols with possible spaces between them

Update domain information

Function: domain.refresh

Update domain information

Access level: reseller admin user

Parameters:

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

Result: successful operation or error message

Domain properties

Function: domain.edit

Access level: admin user reseller

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

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

  • dtype - Type. Select a domain type: master - this server handles the domain zone; slave - the zone information is kept on the primary name server.
  • name - Domain name. Enter the name of the name serves that will handle DNS records for this domain
  • masterip - Master IP . Enter the IP address of the primary names server from which the zone information will be taken
  • ip - IP address. List of IP addresses associated with this domain
  • email - Administrator email. Enter the email address for the DNS administrator
  • dnssec - . (Optional parameter. To enable the option click "on".) Protect with DNSSEC
  • dnssec_turn_off - . (Optional parameter. To enable the option click "on".) Disable DNSSEC protection

Delete the selected domains

Function: domain.delete

Delete the selected domains

Access level: reseller admin user

Parameters:

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

Result: successful operation or error message

Name

Function: domain.dnssecinfo


DNSSEC parameters

Access level: reseller admin user

Set filter.

domain.filter

Problem domains

Function: problem.domains

Result: the list of elements

Problem domains

Access level: admin

  • domain - Domain name
  • namespace - DNS namespace
  • owner - Owner
  • lastrefresh - No updates (days)

Delete

Function: problem.domains.delete

Delete

Access level: admin

Parameters:

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

Result: successful operation or error message

Resellers

Function: reseller

Result: the list of elements

Resellers

Access level: admin

  • name - Name
  • namespace - DNS namespace
  • ip - IP address
  • users - Users
  • domains - Domains
  • props - Properties
  • note - Notes

Suspend

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

Result: successful operation or error message

Reseller management

Function: reseller.delete

Reseller management

Access level: admin

Parameters:

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

Result: successful operation or error message

Reseller parameters

Function: reseller.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 reseller 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 for the reseller that he will use to log into the control panel
  • passwd - . Enter a password to access the control panel
  • confirm - Confirmation. Re-type the password to ensure it was entered correctly
  • namespace - DNS namespace. Enter a DNS namespace
  • two_ip - . (Optional parameter. To enable the option click "on".) Allocate two IPv4 to user's names space
  • ip - IP address. The IP address assigned to the user's namespace
  • ip6 - IPv6 address. The IPv6 address assigned to the user's namespace
  • userlimit - User limit. Enter the maximum number of users that this reseller can create
  • domainlimit - Domain limit. Enter the maximum number of domains that this reseller can create
  • note - Notes. Enter any additional information

Drill down to the reseller panel

Function: su

Drill down to the reseller panel

Access level: admin

Resume

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

Result: successful operation or error message

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

Administrators

Function: admin

Result: the list of elements

Administrator management

Access level: root admin

  • name - Username
  • props - Properties
  • note - Notes

Resume

Function: admin.resume

Resume

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 admin function.

Result: successful operation or error message

Delete the selected administrator

Function: admin.delete

Delete the selected administrator

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 admin function.

Result: successful operation or error message

Suspend

Function: admin.suspend

Suspend

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 admin function.

Result: successful operation or error message

Admin parameters

Function: admin.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 admin 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 that the newly created administrator will use to access the control panel
  • passwd - . Enter a password to access the control panel
  • confirm - Confirmation. Re-type the password to ensure it was entered correctly
  • note - Notes. Enter any additional information

Domain creation settings

Function: dnsparam

Access level: reseller 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):

  • 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.
  • mail - Mail servers. Enter the name(s) of the mail servers that will handle the e-mail for this domain.
  • arecord - Subdomains. Enter a list of subdomains that will be created automatically when adding a new domain
  • fix - . (Optional parameter. To enable the option click "on".) Select the check box if you want to apply the changes to all of the existing domains. Otherwise, parameters will be applied only to newly created domain zones
  • allowtransfer - Allow-transfer. Allow to transfer the zone information to the slave name servers specified on the list.

Global settings

Function: dnsmgrparam

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

  • useipv4 - . (Optional parameter. To enable the option click "on".) Select the check box to use IPv4
  • useipv6 - . (Optional parameter. To enable the option click "on".) Select the check box if you want to use IPv6
  • usednssec - . (Optional parameter. To enable the option click "on".) Enable DNSSEC
  • ksk_algorithm - Algorithm. Algorithm used to generate a key
  • ksk_key_size - Key length. Number of bits in a key
  • ksk_rsasha512_size - Key length.
  • ksk_period - Renewal period. Key restoration period
  • zsk_algorithm - Algorithm. Algorithm used to generate a key
  • zsk_key_size - Key length. Number of bits in the key
  • zsk_rsasha512_size - Key length.
  • zsk_period - Renewal period. Key update period

Notifications

Function: problems

Result: the list of elements

Notifications

Access level: reseller user

  • 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: reseller 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 (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: reseller user

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: reseller 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 (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: reseller user

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: reseller user

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

Set filter.

problems.filter

IP settings

Function: ipparam

Access level: reseller 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):

  • ip - IP address. The IP address assigned to the user's namespace
  • ip6 - IPv6 address. The IPv6 address assigned to the user's namespace
  • domain - Domain name. Enter a domain name that coressponds to this IP address (PTR)

Shared domains

Function: shareddomain

Result: the list of elements

Shared domains management

Access level: reseller

  • name - Domain name

Rename

Function: shareddomain.edit

Access level: reseller

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

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

  • name - Domain name. In the specified domain all users can add domain names of a lower level
  • domainlimit - Domain limit. Enter the maximum number of subdomains that a user will be allowed to add

Delete the selected shared domain names

Function: shareddomain.delete

Delete the selected shared domain names

Access level: reseller

Parameters:

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

Result: successful operation or error message

Users

Function: user

Result: the list of elements

User management

Access level: reseller admin

  • name - Username
  • parent - Owner
  • namespace - DNS namespace
  • ip - IP address
  • domains - Domains
  • props - Properties
  • note - Notes

User parameters

Function: user.edit

Access level: admin reseller

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
  • passwd - . Enter a password to access the control panel
  • confirm - Confirmation. Re-type the password to ensure it was entered correctly
  • ownnamespace - . (Optional parameter. To enable the option click "on".) If this check box is not selected, the reseller's namespace will be used
  • namespace - DNS namespace. DNS namespace enables to arange domain information in such a way that domains of one user do not intersect domains of another. Each name space requires a separate IP address. If you are going to allocate a single IP to multiple users, you first need to create a reseller. For more information see to the Documentation
  • ip - IP address. The IP address assigned to the user's namespace
  • ip6 - IPv6 address . The IPv6 address assigned to the user's namespace
  • domainlimit - Domain limit. Enter the maximum number of domains this user can create
  • note - Notes. Enter any additional information

Set filter.

user.filter

Suspend

Function: user.suspend

Suspend

Access level: reseller 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

Delete the selected users

Function: user.delete

Delete the selected users

Access level: reseller 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

Resume

Function: user.resume

Resume

Access level: reseller 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

User settings

Function: usrparam

Access level: reseller 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
  • 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

Slave servers

Function: slaveserver

Result: the list of elements

Slave name servers

Access level: reseller user

  • url - Control panel URL
  • username - Username

Slave name server

Function: slaveserver.edit

Access level: user reseller

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

Delete the selected slave name servers

Function: slaveserver.delete

Delete the selected slave name servers

Access level: reseller user

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

Forbidden domains

Function: dns.blacklist

Result: the list of elements

Forbidden domains management

Access level: root admin

  • name - Domain name

Delete

Function: dns.blacklist.delete

Delete

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 dns.blacklist function.

Result: successful operation or error message

Rename

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

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

  • name - Domain name. Users cannot use this domain name to create their domains