Difference between revisions of "API: Nameserver"

From BrainyCP
Jump to: navigation, search
m (Protected "API: Nameserver" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
 
(One intermediate revision by the same user not shown)
Line 128: Line 128:
 
Other useful articles:
 
Other useful articles:
  
{| style="width: 1191px;"
+
{| style="width: 1073px;"
 
|-
 
|-
|  
+
| style="width: 296px;" |  
'''[https://docs.brainycp.io/index.php/API:_подключение API: подключение]'''
+
'''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]'''
  
|  
+
| style="width: 384px;" |  
'''[https://docs.brainycp.io/index.php/API:_мониторинг API: мониторинг]'''
+
'''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]'''
  
|  
+
| style="width: 371px;" |  
'''[https://docs.brainycp.io/index.php/API:_статус_веб-сервера API: статус веб-сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 296px;" |  
'''[https://docs.brainycp.io/index.php/API:_автоустановщик_CMS API: автоустановщик CMS]'''
+
'''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]'''
  
|  
+
| style="width: 384px;" |  
'''[https://docs.brainycp.io/index.php/API:_настройка_бекапов API: настройка бекапов]'''
+
'''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]'''
  
|  
+
| style="width: 371px;" |  
'''[https://docs.brainycp.io/index.php/API:_трансфер_между_серверами API: трансфер между серверами]'''
+
'''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 296px;" |  
'''[https://docs.brainycp.io/index.php/API:_антивирус API: антивирус]'''
+
'''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]'''
  
|  
+
| style="width: 384px;" |  
'''[https://docs.brainycp.io/index.php/API:_настройки_сервера API: настройки сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]'''
  
|  
+
| style="width: 371px;" |  
'''[https://docs.brainycp.io/index.php/API:_управление_веб-сервером API: управление веб-сервером]'''
+
'''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 296px;" |  
'''[https://docs.brainycp.io/index.php/API:_базы_данных API: базы данных]'''
+
'''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]'''
  
|  
+
| style="width: 384px;" |  
'''[https://docs.brainycp.io/index.php/API:_пользовательские_сертификаты API: пользовательские сертификаты]'''
+
'''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]'''
  
|  
+
| style="width: 371px;" |  
'''[https://docs.brainycp.io/index.php/API:_управление_почтовыми_ящиками API: управление почтовыми ящиками]'''
+
'''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 296px;" |  
'''[https://docs.brainycp.io/index.php/API:_информация_о_сервере API: информация о сервере]'''
+
'''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]'''
  
|  
+
| style="width: 384px;" |  
'''[https://docs.brainycp.io/index.php/API:_почта API: почта]'''
+
'''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]'''
  
|  
+
| style="width: 371px;" |  
'''[https://docs.brainycp.io/index.php/API:_управление_DNS-зонами API: управление DNS-зонами]'''
+
'''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 296px;" |  
'''[https://docs.brainycp.io/index.php/API:_использование_трафика API: использование трафика]'''
+
'''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]'''
  
|  
+
| style="width: 384px;" |  
'''[https://docs.brainycp.io/index.php/API:_почтовые_ящики_клиента API: почтовые ящики клиента]'''
+
'''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]'''
  
|  
+
| style="width: 371px;" |  
'''[https://docs.brainycp.io/index.php/API:_установка_веб-сервера API: установка веб-сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 296px;" |  
'''[https://docs.brainycp.io/index.php/API:_логирование API: логирование]'''
+
'''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]'''
  
|  
+
| style="width: 384px;" |  
'''[https://docs.brainycp.io/index.php/API:_сервер_имен API: сервер имен]'''
+
'''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]'''
  
|  
+
| style="width: 371px;" |  
'''[https://docs.brainycp.io/index.php/API:_хост-аккаунты API: хост-аккаунты]'''
+
'''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 296px;" |  
'''[https://docs.brainycp.io/index.php/API:_менеджер_приложений API: менеджер приложений]'''
+
'''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]'''
  
|  
+
| style="width: 384px;" |  
'''[https://docs.brainycp.io/index.php/API:_сертификаты_сервисов API: сертификаты сервисов]'''
+
'''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]'''
  
|  
+
| style="width: 371px;" |  
'''[https://docs.brainycp.io/index.php/API:_CRON API: CRON]'''
+
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 296px;" |  
'''[https://docs.brainycp.io/index.php/API:_менеджер_процессов API: менеджер процессов]'''
+
'''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]'''
  
|  
+
| style="width: 384px;" |  
'''[https://docs.brainycp.io/index.php/API:_сетевые_инструменты API: сетевые инструменты]'''
+
'''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]'''
  
|  
+
| style="width: 371px;" |  
'''[https://docs.brainycp.io/index.php/API:_FTP-сервер API: FTP-сервер]'''
+
'''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]'''
  
 
|-
 
|-
|  
+
| style="width: 296px;" |  
'''[https://docs.brainycp.io/index.php/API:_менеджер_IP-адресов API: менеджер IP-адресов]'''
+
'''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]'''
  
|  
+
| style="width: 384px;" |  
'''[https://docs.brainycp.io/index.php/API:_средняя_нагрузка API: средняя нагрузка]'''
+
'''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]'''
  
|  
+
| style="width: 371px;" |  
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist API: MySQL processlist]'''
+
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]'''
  
 
|}
 
|}

Latest revision as of 14:27, 17 November 2021

Administrative functions require API root rights in order to use any login hosted on the server. If you do not have root rights, you can only use your login.
Incoming data marked with an asterisk are required.

Module

Function

Incoming data

Error variants

bindserver

Start/stop/restart of nameserver.

operation

 
Username (post or get) * - username;

password (post or get) * - user password;

bindserver (post or get) * - constant, module name;

operation (post or get) * - constant, operation name;

command (post or get) * - choice

commands:

start - Start bind server;

restart - restart the bind server;

stop - stop the bind server.

language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Command completed', detail [console message];
error: 100, mess: 'Error in command writing', detail [list of commands];
error: 101, mess: 'Error in command execution';
error: 400, mess: 'Unfortunately, the module is not available to you.'

bindserver

Show list of ns-servers by default.

list_ns_server

username (post or get) * - username;
password (post or get) * - user password;
bindserver (post or get) * - constant, module name;
list_ns_server (post or get) * - constant, operation name;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'List of NS servers', detail [list_ns_server];
error: 100, mess: 'The list of NS servers is empty';
error: 400, mess: 'Unfortunately, the module is not available to you.'

bindserver

Editing the default ns-server list (adding, deleting, replacing, reordering).

edit_ns_server

username (post or get) * - username;
password (post or get) * - user password;
bindserver (post or get) * - constant, module name;
edit_ns_server (post or get) * - constant, operation name;
operetion (post or get) * - takes values:
delete - Delete ns server;
add - add ns server;
edit_number - change the order;
edit_claster - Takes an array of key values.
When you select add, the required parameters are host, ip (Hostname and its ip).
If you select delete, the required parameters are host (Delete selected host).
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'The NS records table is saved by default';
error: 1, mess: 'The specified zone name is invalid';
error: 2, mess: 'The specified IP address is invalid';
error: 100, mess: 'The value must be an array';
error: 400, mess: 'Unfortunately, the module is not available to you.'

bindserver

Reassembling.

username (post or get) * - username;
password (post or get) * - user password;
bindserver (post or get) * - constant, module name;
rebild (post or get) * - constant, operation name;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'The NS records table was successfully rebuilt';
error: 400, mess: 'Unfortunately, the module is not available to you.'

bindserver

Show cluster.

show_claster

username (post or get) * - username;
password (post or get) * - user password;
bindserver (post or get) * - constant, module name;
show_claster (post or get) * - constant, operation name;
language (post or get) - can take the value: en / ru (ru by default).

 

error: 0, message: 'View cluster array', detail [array_claster]; error: 100, message: 'The cluster array is empty'; error: 400, message: 'Unfortunately, the module is not available to you.'

bindserver

Generate and save key.

token

username (post or get) * - username;
password (post or get) * - user password;
bindserver (post or get) * - constant, module name;
token (post or get) * - constant, operation name;
command (post or get) * - command:
generate - key generation;
save - save the key.
When choosing save:
token (post or get) * - the key to be saved.
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Key generated', detail [key];
error: 100, mess: 'Error in key generation';
error: 101, mess: 'Empty or invalid key value';
error: 400, mess: 'Unfortunately, the module is not available to you.'

bindserver

Delete server from cluster.

delete_cluster

username (post or get) * - username;
password (post or get) * - user password;
bindserver (post or get) * - constant, module name;
delete_cluster (post or get) * - constant, operation name;
ip (post or get) * - the ip-address of the server to be removed from the cluster;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, message: 'Delete request completed';
error: 100, message: 'Incorrect ip address entered';
error: 400, message: 'Unfortunately, the module is not available to you.'

bindserver

Edit server in cluster.

edit_cluster

 

username (post or get) * - username; password (post or get) * - user password; bindserver (post or get) * - constant, module name; edit_cluster (post or get) * - constant, operation name; ip (post or get) * - the ip-address of the edited server from the cluster; host (post or get) * - host of the edited server; key (post or get) * - sha256 key; type (post or get) * - takes 2 values ​​one, two; enable (post or get) - default 0; language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess: 'Sucessfully edited';
error: 100, mess: 'Invalid value type', detail [type];
error: 101, mess: 'Invalid ID';
error: 102, mess: 'Invalid IP Address';
error: 103, mess: 'Invalid HOST';
error: 104, mess: 'Invalid key';
error: 106, mess: 'There is no connection to server'.

bindserver

Adding server to cluster.

add_cluster

username (post or get) * - username;
password (post or get) * - user password;
bindserver (post or get) * - constant, module name;
edit_cluster (post or get) * - constant, operation name;
ip (post or get) * - the ip-address of the server added to the cluster;
host (post or get) * - host of the added server;
key (post or get) * - sha256 key;
type (post or get) * - takes 2 values ​​one, two;
language (post or get) - can take the value: en / ru (ru by default).
error: 0, mess:
error: 100, mess: 'Invalid ip-address entered';
error: 101, mess: 'Missing host value';
error: 102, mess: 'Missing key value';
error: 103, mess: 'Invalid value type', detail [type];
error: 106, mess: 'There is no connection to server';
error: 110, mess: 'Another error';
error: 400, mess: 'Unfortunately, the module is not available to you.'

Other useful articles:

API: connection

API: monitoring

API: web server status

API: auto installer CMS

API: configuring backups

API: transfer between servers

API: antivirus

API: server settings

API: web server management

API: database

API: custom certificates

API: mailbox management

API: server information

API: mail

API: DNS zone management

API: traffic usage

API: client mailboxes

API: web server installation

API: logging

API: name server

API: host accounts

API: application manager

API: service certificates

API: CRON

API: process manager

API: network tools

API: FTP server

API: IP address manager

API: average load

API: MySQL processlist