Difference between revisions of "API: IP-address manager"

From BrainyCP
Jump to: navigation, search
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
  
−
Администраторские функции требуют root-права API, чтобы использовать любой логин, размещенный на сервере. Если root-прав нет, можно использовать только свой логин.
+
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.
  
 
{| border="1" cellpadding="5"
 
{| border="1" cellpadding="5"
 
|-
 
|-
−
| <p dir="ltr" style="text-align: center;">'''Модуль'''</p>  
+
| style="width: 64px;" | <p dir="ltr" style="text-align: center;">'''Module'''</p>  
−
| <p dir="ltr" style="text-align: center;">'''Функция'''</p>  
+
| style="width: 89px;" | <p dir="ltr" style="text-align: center;">'''Function'''</p>  
−
| <p dir="ltr" style="text-align: center;">'''Входящие данные'''</p>  
+
| <p dir="ltr" style="text-align: center;">'''Incoming data'''</p>  
−
| <p dir="ltr" style="text-align: center;">'''Варианты ошибок'''</p>  
+
| <p dir="ltr" style="text-align: center;">'''Error variants'''</p>  
 
|-
 
|-
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 64px;" |  
 
ipmanager
 
ipmanager
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 89px;" |  
−
Список ipv4.
+
List ipv4.
  
 
listipv4ipm
 
listipv4ipm
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">ipmanager (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">listipv4ipm (post or get) * - constant, operation name.</div>
−
username (post или get)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'The list of IP addresses was received successfully';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'An error occurred while getting the list of IP addresses';</div> <div data-placeholder="Перевод" dir="ltr">error: 1003, mess: 'You do not have administrator rights'.</div>  
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
ipmanager (post или get)* — константа, имя модуля;
 
−
 
 
−
listipv4ipm (post или get)* — константа, имя операции.
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Список IP адресов был успешно получен';
 
−
 
 
−
error:1, mess:'Произошла ошибка при получении списка IP адресов';
 
−
 
 
−
error:1003, mess:'У вас нет прав администратора'.<br/> &nbsp;
 
−
 
 
 
|-
 
|-
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 64px;" |  
 
ipmanager
 
ipmanager
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 89px;" |  
−
Список ipv6.
+
List ipv6.
  
 
listipv6ipm
 
listipv6ipm
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">ipmanager (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">listipv6ipm (post or get) * - constant, operation name.</div>
−
username (post или get)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'The list of IP addresses was received successfully';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'An error occurred while getting the list of IP addresses';</div> <div data-placeholder="Перевод" dir="ltr">error: 1003, mess: 'You do not have administrator rights'.</div>  
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
ipmanager (post или get)* — константа, имя модуля;
 
−
 
 
−
listipv6ipm (post или get)* — константа, имя операции.
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'Список IP адресов был успешно получен';
 
−
 
 
−
error:1, mess:'Произошла ошибка при получении списка IP адресов';
 
−
 
 
−
error:1003, mess:'У вас нет прав администратора'.<br/> &nbsp;
 
−
 
 
 
|-
 
|-
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 64px;" |  
 
ipmanager
 
ipmanager
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 89px;" |  
−
Добавление айпи.
+
Add ip.
  
 
addipm
 
addipm
  
 +
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">ipmanager (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">addipm (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">ip_net (post or get) * - ip address of vip4 or vip6;</div> <div data-placeholder="Перевод" dir="ltr">netmask (post or get) * - subnet mask;</div> <div data-placeholder="Перевод" dir="ltr">gateway (post or get) * - gateway.</div>
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
−
username (post или get)* — имя пользователя;
+
&nbsp;
−
 
+
<div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'New IP address was added successfully';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'An error occurred while adding an IP address';</div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'The specified IP address is invalid';</div> <div data-placeholder="Перевод" dir="ltr">error: 3, mess: 'The specified mask is invalid';</div> <div data-placeholder="Перевод" dir="ltr">error: 4, mess: 'The specified gateway is invalid';</div> <div data-placeholder="Перевод" dir="ltr">error: 1003, mess: 'You do not have administrator rights'.</div>
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
ipmanager (post или get)* — константа, имя модуля;
 
−
 
 
−
addipm (post или get)* — константа, имя операции;
 
−
 
 
−
ip_net (post или get)* — айпи адрес vip4 или vip6;
 
−
 
 
−
netmask (post или get)* — маска подсети;
 
−
 
 
−
gateway (post или get)* — шлюз.
 
−
 
 
−
| style="vertical-align: top;" |
 
−
error:0, mess:'Новый IP адрес был успешно добавлен';
 
−
 
 
−
error:1, mess:'Произошла ошибка при добавлении IP адреса';
 
−
 
 
−
error:2, mess:'Указанный IP адрес некорректный';
 
−
 
 
−
error:3, mess:'Указанная маска некорректна';
 
−
 
 
−
error:4, mess:'Указанный шлюз некорректный';
 
−
 
 
−
error:1003, mess:'У вас нет прав администратора'.
 
−
 
 
 
|-
 
|-
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 64px;" |  
 
ipmanager
 
ipmanager
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top; width: 89px;" |  
−
Удаление айпи.
+
Delete ip.
  
 
delipm
 
delipm
  
−
| style="vertical-align: top;" |  
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">username (post or get) * - username;</div> <div data-placeholder="Перевод" dir="ltr">password (post or get) * - user password;</div> <div data-placeholder="Перевод" dir="ltr">ipmanager (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">delipm (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">ip_net (post or get) * - ip address of vip4 or vip6.</div>
−
username (post или get)* — имя пользователя;
+
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'The IP address was deleted successfully';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'An error occurred while deleting the IP address';</div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'The specified IP address is invalid';</div> <div data-placeholder="Перевод" dir="ltr">error: 1003, mess: 'You do not have&nbsp;</div>
−
 
 
−
password (post или get)* — пароль пользователя;
 
−
 
 
−
ipmanager (post или get)* — константа, имя модуля;
 
−
 
 
−
delipm (post или get)* — константа, имя операции;
 
−
 
 
−
ip_net (post или get)* — айпи адрес vip4 или vip6.
 
−
 
 
−
| style="vertical-align: top;" |  
 
−
error:0, mess:'IP адрес был успешно удален';
 
−
 
 
−
error:1, mess:'Произошла ошибка при удалении IP адреса';
 
−
 
 
−
error:2, mess:'Указанный IP адрес некорректный';
 
−
 
 
−
error:1003, mess:'У вас нет прав администратора'.
 
−
 
 
 
|}
 
|}
  
−
Другие полезные статьи:
+
Other useful articles:
  
−
{| style="width: 1191px;"
+
{| style="width: 991px;"
 
|-
 
|-
−
|  
+
| style="width: 256px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_подключение API: подключение]'''
+
'''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]'''
  
−
|  
+
| style="width: 341px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_мониторинг API: мониторинг]'''
+
'''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]'''
  
−
|  
+
| style="width: 372px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_статус_веб-сервера API: статус веб-сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 256px;" |  
−
'''[https://docs.brainycp.ru/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: 341px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_настройка_бекапов API: настройка бекапов]'''
+
'''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]'''
  
−
|  
+
| style="width: 372px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_трансфер_между_серверами API: трансфер между серверами]'''
+
'''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 256px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_антивирус API: антивирус]'''
+
'''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]'''
  
−
|  
+
| style="width: 341px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_настройки_сервера API: настройки сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]'''
  
−
|  
+
| style="width: 372px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_управление_веб-сервером API: управление веб-сервером]'''
+
'''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 256px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_базы_данных API: базы данных]'''
+
'''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]'''
  
−
|  
+
| style="width: 341px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_пользовательские_сертификаты API: пользовательские сертификаты]'''
+
'''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]'''
  
−
|  
+
| style="width: 372px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_управление_почтовыми_ящиками API: управление почтовыми ящиками]'''
+
'''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 256px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_информация_о_сервере API: информация о сервере]'''
+
'''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]'''
  
−
|  
+
| style="width: 341px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_почта API: почта]'''
+
'''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]'''
  
−
|  
+
| style="width: 372px;" |  
−
'''[https://docs.brainycp.ru/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: 256px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_использование_трафика API: использование трафика]'''
+
'''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]'''
  
−
|  
+
| style="width: 341px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_почтовые_ящики_клиента API: почтовые ящики клиента]'''
+
'''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]'''
  
−
|  
+
| style="width: 372px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_установка_веб-сервера API: установка веб-сервера]'''
+
'''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 256px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_логирование API: логирование]'''
+
'''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]'''
  
−
|  
+
| style="width: 341px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_сервер_имен API: сервер имен]'''
+
'''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]'''
  
−
|  
+
| style="width: 372px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_хост-аккаунты API: хост-аккаунты]'''
+
'''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 256px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_менеджер_приложений API: менеджер приложений]'''
+
'''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]'''
  
−
|  
+
| style="width: 341px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_сертификаты_сервисов API: сертификаты сервисов]'''
+
'''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]'''
  
−
|  
+
| style="width: 372px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_CRON API: CRON]'''
+
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 256px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_менеджер_процессов API: менеджер процессов]'''
+
'''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]'''
  
−
|  
+
| style="width: 341px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_сетевые_инструменты API: сетевые инструменты]'''
+
'''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]'''
  
−
|  
+
| style="width: 372px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_FTP-сервер API: FTP-сервер]'''
+
'''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]'''
  
 
|-
 
|-
−
|  
+
| style="width: 256px;" |  
−
'''[https://docs.brainycp.ru/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: 341px;" |  
−
'''[https://docs.brainycp.ru/index.php/API:_средняя_нагрузка API: средняя нагрузка]'''
+
'''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]'''
  
−
|  
+
| style="width: 372px;" |  
−
'''[https://docs.brainycp.ru/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:20, 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

ipmanager

List ipv4.

listipv4ipm

username (post or get) * - username;
password (post or get) * - user password;
ipmanager (post or get) * - constant, module name;
listipv4ipm (post or get) * - constant, operation name.
error: 0, mess: 'The list of IP addresses was received successfully';
error: 1, mess: 'An error occurred while getting the list of IP addresses';
error: 1003, mess: 'You do not have administrator rights'.

ipmanager

List ipv6.

listipv6ipm

username (post or get) * - username;
password (post or get) * - user password;
ipmanager (post or get) * - constant, module name;
listipv6ipm (post or get) * - constant, operation name.
error: 0, mess: 'The list of IP addresses was received successfully';
error: 1, mess: 'An error occurred while getting the list of IP addresses';
error: 1003, mess: 'You do not have administrator rights'.

ipmanager

Add ip.

addipm

username (post or get) * - username;
password (post or get) * - user password;
ipmanager (post or get) * - constant, module name;
addipm (post or get) * - constant, operation name;
ip_net (post or get) * - ip address of vip4 or vip6;
netmask (post or get) * - subnet mask;
gateway (post or get) * - gateway.

 

error: 0, mess: 'New IP address was added successfully';
error: 1, mess: 'An error occurred while adding an IP address';
error: 2, mess: 'The specified IP address is invalid';
error: 3, mess: 'The specified mask is invalid';
error: 4, mess: 'The specified gateway is invalid';
error: 1003, mess: 'You do not have administrator rights'.

ipmanager

Delete ip.

delipm

username (post or get) * - username;
password (post or get) * - user password;
ipmanager (post or get) * - constant, module name;
delipm (post or get) * - constant, operation name;
ip_net (post or get) * - ip address of vip4 or vip6.
error: 0, mess: 'The IP address was deleted successfully';
error: 1, mess: 'An error occurred while deleting the IP address';
error: 2, mess: 'The specified IP address is invalid';
error: 1003, mess: 'You do not have 

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

Retrieved from "https://docs.brainycp.io/index.php?title=API:_IP-address_manager&oldid=1928"