Difference between revisions of "API: Manage DNS-zones"
From BrainyCP
(5 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
| | ||
− | + | <div data-placeholder="Перевод" dir="ltr">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.</div> <div data-placeholder="Перевод" dir="ltr">Incoming data marked with an asterisk are required.</div> | |
− | |||
− | |||
− | |||
− | |||
{| border="1" cellpadding="5" | {| border="1" cellpadding="5" | ||
|- | |- | ||
− | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''Module'''</p> |
− | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''Function'''</p> |
− | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''Incoming data'''</p> |
− | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''Error variants'''</p> |
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
Line 17: | Line 13: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | show DNS-zones. | |
show_zones | show_zones | ||
− | | 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">bindserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">show_zones (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">zone (post or get) * - zone name;</div> <div data-placeholder="Перевод" dir="ltr">user_edit (post or get) - the name of the user being edited.</div> |
− | username (post | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Successful output of the zone';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'This zone does not belong to you. Or she's not there ';</div> <div data-placeholder="Перевод" dir="ltr">error: 101, mess: 'The zone array is empty.</div> <div data-placeholder="Перевод" dir="ltr">The zone array is empty. Perhaps you have no rights'</div> |
− | |||
− | password (post | ||
− | |||
− | bindserver (post | ||
− | |||
− | show_zones (post | ||
− | |||
− | zone (post | ||
− | |||
− | user_edit (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, mess:' | ||
− | |||
− | error:100, mess:' | ||
− | |||
− | error:101, mess:' | ||
− | |||
− | |||
− | |||
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
Line 48: | Line 24: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | List ofDNS-zones for user/users. | |
list_zones | list_zones | ||
− | | 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">bindserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">list_zones (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">user_edit (post or get) - the name of the user being edited;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div> |
− | username (post | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'List of user zones', zones [array zones];</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'List of all zones', zones [array zones];</div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'List of own zones', zones [array zones];</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'This zone does not belong to you. Or is she not '</div> |
− | |||
− | password (post | ||
− | |||
− | bindserver (post | ||
− | |||
− | list_zones (post | ||
− | |||
− | user_edit (post | ||
− | |||
− | language (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, mess:' | ||
− | |||
− | error:1, mess:' | ||
− | |||
− | error:2, mess:' | ||
− | |||
− | error:100, mess:' | ||
− | |||
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
Line 79: | Line 35: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | Add DNS-zone. | |
add_zones | add_zones | ||
− | | 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">bindserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">add_zones (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">zone (post or get) * - zone name;</div> <div data-placeholder="Перевод" dir="ltr">IP (post or get) * - IP address;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div> |
− | username (post | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Zone added successfully';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'The specified zone name is invalid';</div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'The specified IP address is invalid';</div> <div data-placeholder="Перевод" dir="ltr">error: 500, mess: 'Error adding zone. Perhaps such a zone exists';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'You do not have sufficient rights. Remove the user_edit 'field.</div> |
− | |||
− | password (post | ||
− | |||
− | bindserver (post | ||
− | |||
− | add_zones (post | ||
− | |||
− | zone (post | ||
− | |||
− | IP (post | ||
− | |||
− | language (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, mess:' | ||
− | |||
− | error:1, mess:' | ||
− | |||
− | error:2, mess:' | ||
− | |||
− | error:500, mess:' | ||
− | |||
− | error:400, mess:' | ||
− | |||
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
Line 114: | Line 46: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | delete DNS-zone. | |
delete_zones | delete_zones | ||
− | | 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">bindserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">delete_zones (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">zone (post or get) * - zone name;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div> |
− | username (post | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Zone deleted successfully';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'This zone does not belong to you. Or she's not there ';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'You do not have sufficient rights. Remove the field user_edit ';</div> <div data-placeholder="Перевод" dir="ltr">error: 500, mess: 'Error deleting zone. Perhaps there is no such zone. '</div> |
− | |||
− | password (post | ||
− | |||
− | bindserver (post | ||
− | |||
− | delete_zones (post | ||
− | |||
− | zone (post | ||
− | |||
− | language (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, mess:' | ||
− | |||
− | error:100, mess:' | ||
− | |||
− | error:400, mess:' | ||
− | |||
− | error:500, mess:' | ||
− | |||
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
Line 145: | Line 57: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | Edit DNS-zone. | |
edit_zones | edit_zones | ||
− | | 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">bindserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">edit_zones (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">zone (post or get) * - zone name;</div> <div data-placeholder="Перевод" dir="ltr">type (post or get) * - post type;</div> <div data-placeholder="Перевод" dir="ltr">value (post or get) * - value value;</div> <div data-placeholder="Перевод" dir="ltr">name (post or get) * - value of name;</div> <div data-placeholder="Перевод" dir="ltr">line (post or get) * - line number;</div> <div data-placeholder="Перевод" dir="ltr">delete (post or get) * - delete;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default);</div> <div data-placeholder="Перевод" dir="ltr">user_edit (post or get) - the name of the user being edited.</div> |
− | username (post | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'The entry was deleted';</div> <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'New entry added';</div> <div data-placeholder="Перевод" dir="ltr">error: 0, message: 'The zone record was successfully edited';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'This zone does not belong to you. Or she's not there ';</div> <div data-placeholder="Перевод" dir="ltr">error: 101, mess: 'Record type mismatch';</div> <div data-placeholder="Перевод" dir="ltr">error: 102, mess: 'Zone name is empty';</div> <div data-placeholder="Перевод" dir="ltr">error: 103, mess: 'The line number must be a number';</div> <div data-placeholder="Перевод" dir="ltr">error: 104, mess: 'Uneditable line numbers';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.</div> |
− | |||
− | password (post | ||
− | |||
− | bindserver (post | ||
− | |||
− | edit_zones (post | ||
− | |||
− | zone (post | ||
− | |||
− | type (post | ||
− | |||
− | value (post | ||
− | |||
− | name (post | ||
− | |||
− | line (post | ||
− | |||
− | delete (post | ||
− | |||
− | language (post | ||
− | |||
− | user_edit (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, mess:' | ||
− | |||
− | error:0, mess:' | ||
− | |||
− | error:0, message:' | ||
− | |||
− | error:100, mess:' | ||
− | |||
− | error:101, mess:' | ||
− | |||
− | error:102, mess:' | ||
− | |||
− | error:103, mess:' | ||
− | |||
− | error:104, mess:' | ||
− | |||
− | error:400, mess:' | ||
− | |||
|} | |} | ||
− | + | Other useful articles: | |
− | {| style="width: | + | {| style="width: 1146px;" |
|- | |- | ||
− | | | + | | style="width: 312px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]''' |
− | | | + | | style="width: 388px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]''' |
− | | | + | | style="width: 424px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 312px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]''' |
− | | | + | | style="width: 388px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]''' |
− | | | + | | style="width: 424px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 312px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]''' |
− | | | + | | style="width: 388px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]''' |
− | | | + | | style="width: 424px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 312px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]''' |
− | | | + | | style="width: 388px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]''' |
− | | | + | | style="width: 424px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 312px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]''' |
− | | | + | | style="width: 388px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]''' |
− | | | + | | style="width: 424px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 312px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]''' |
− | | | + | | style="width: 388px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]''' |
− | | | + | | style="width: 424px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 312px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]''' |
− | | | + | | style="width: 388px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]''' |
− | | | + | | style="width: 424px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 312px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]''' |
− | | | + | | style="width: 388px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]''' |
− | | | + | | style="width: 424px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 312px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]''' |
− | | | + | | style="width: 388px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]''' |
− | | | + | | style="width: 424px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 312px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]''' |
− | | | + | | style="width: 388px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]''' |
− | | | + | | style="width: 424px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]''' |
|} | |} |
Latest revision as of 14:38, 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 |
show DNS-zones. show_zones |
username (post or get) * - username; password (post or get) * - user password; bindserver (post or get) * - constant, module name; show_zones (post or get) * - constant, operation name; zone (post or get) * - zone name; user_edit (post or get) - the name of the user being edited.
|
error: 0, mess: 'Successful output of the zone'; error: 100, mess: 'This zone does not belong to you. Or she's not there '; error: 101, mess: 'The zone array is empty. The zone array is empty. Perhaps you have no rights'
|
bindserver |
List ofDNS-zones for user/users. list_zones |
username (post or get) * - username; password (post or get) * - user password; bindserver (post or get) * - constant, module name; list_zones (post or get) * - constant, operation name; user_edit (post or get) - the name of the user being edited; language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, mess: 'List of user zones', zones [array zones]; error: 1, mess: 'List of all zones', zones [array zones]; error: 2, mess: 'List of own zones', zones [array zones]; error: 100, mess: 'This zone does not belong to you. Or is she not '
|
bindserver |
Add DNS-zone. add_zones |
username (post or get) * - username; password (post or get) * - user password; bindserver (post or get) * - constant, module name; add_zones (post or get) * - constant, operation name; zone (post or get) * - zone name; IP (post or get) * - IP address; language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, mess: 'Zone added successfully'; error: 1, mess: 'The specified zone name is invalid'; error: 2, mess: 'The specified IP address is invalid'; error: 500, mess: 'Error adding zone. Perhaps such a zone exists'; error: 400, mess: 'You do not have sufficient rights. Remove the user_edit 'field.
|
bindserver |
delete DNS-zone. delete_zones |
username (post or get) * - username; password (post or get) * - user password; bindserver (post or get) * - constant, module name; delete_zones (post or get) * - constant, operation name; zone (post or get) * - zone name; language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, mess: 'Zone deleted successfully'; error: 100, mess: 'This zone does not belong to you. Or she's not there '; error: 400, mess: 'You do not have sufficient rights. Remove the field user_edit '; error: 500, mess: 'Error deleting zone. Perhaps there is no such zone. '
|
bindserver |
Edit DNS-zone. edit_zones |
username (post or get) * - username; password (post or get) * - user password; bindserver (post or get) * - constant, module name; edit_zones (post or get) * - constant, operation name; zone (post or get) * - zone name; type (post or get) * - post type; value (post or get) * - value value; name (post or get) * - value of name; line (post or get) * - line number; delete (post or get) * - delete; language (post or get) - can take the value: en / ru (ru by default); user_edit (post or get) - the name of the user being edited.
|
error: 0, mess: 'The entry was deleted'; error: 0, mess: 'New entry added'; error: 0, message: 'The zone record was successfully edited'; error: 100, mess: 'This zone does not belong to you. Or she's not there '; error: 101, mess: 'Record type mismatch'; error: 102, mess: 'Zone name is empty'; error: 103, mess: 'The line number must be a number'; error: 104, mess: 'Uneditable line numbers'; error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.
|
Other useful articles: