Difference between revisions of "API: Webserver Installation"
From BrainyCP
(7 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 15: | Line 11: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | Add domain. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | add_domain | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
+ | | 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">server_control (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">add_domain (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">dir (post or get) * - directory name;</div> <div data-placeholder="Перевод" dir="ltr">domains (post or get) * - domain 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> <div data-placeholder="Перевод" dir="ltr">php_version (post or get) - php version;</div> <div data-placeholder="Перевод" dir="ltr">bridge (post or get) - bridge;</div> <div data-placeholder="Перевод" dir="ltr">user_edit (post or get) * - the name of the user being edited.</div> <div data-placeholder="Перевод" dir="ltr">aliases (post или get)* — aliases</div> | ||
+ | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'The domain was added successfully';</div> <div data-placeholder="Перевод" dir="ltr">error: 200, mess: 'The domain was added successfully. Php is ***** by default. Available versions - **** ';</div> <div data-placeholder="Перевод" dir="ltr">error: 201, mess: 'The domain was added successfully. The default bridge is *****. Available versions - **** ';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'Invalid username';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'The domain field must be filled';</div> <div data-placeholder="Перевод" dir="ltr">error: 101, mess: 'The directory field must be filled';</div> <div data-placeholder="Перевод" dir="ltr">error: 102, mess: 'The domain already exists';</div> <div data-placeholder="Перевод" dir="ltr">error: 104, mess: 'The domain field is filled incorrectly';</div> <div data-placeholder="Перевод" dir="ltr">Please only use letters, numbers, dashes and periods';</div> <div data-placeholder="Перевод" dir="ltr">error: 105, mess: 'The directory field is filled incorrectly';</div> <div data-placeholder="Перевод" dir="ltr">Please only use letters, numbers, dashes and slashes';</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: 105, mess: 'The directory field is filled incorrectly';</div> <div data-placeholder="Перевод" dir="ltr">Please only use letters, numbers, dashes and forward slashes. ';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'You do not have sufficient rights. Remove the user_edit 'field.</div> | ||
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
Line 78: | Line 22: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | Delete domain | |
− | + | remove_domain | |
− | | 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">server_control (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">remove_domain (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">domains (post or get) * - domain name;</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> <div data-placeholder="Перевод" dir="ltr">remove_folder(post или get) - delete directory 0 or 1 (default 0)</div> |
− | username (post | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Domain deleted successfully';</div> <div data-placeholder="Перевод" dir="ltr">error: 1, mess: 'Invalid username';</div> <div data-placeholder="Перевод" dir="ltr">error: 2, mess: 'Domain not found';</div> <div data-placeholder="Перевод" dir="ltr">error: 3, mess: 'The domain field must be filled';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'You do not have sufficient rights. Remove the user_edit 'field.</div> |
− | + | | |
− | password (post | ||
− | |||
− | server_control (post | ||
− | |||
− | |||
− | |||
− | domains (post | ||
− | |||
− | language (post | ||
− | |||
− | user_edit (post или get) | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, mess:' | ||
− | |||
− | error:1, mess: ' | ||
− | |||
− | error:2, mess:' | ||
− | |||
− | error:3, mess:' | ||
− | |||
− | error:400, mess:' | ||
|- | |- | ||
Line 113: | Line 35: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | Edit domain | |
− | |||
− | |||
− | + | edit_domain | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
+ | | 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">server_control (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">edit_domain (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">domains (post or get) * - domain name;</div> <div data-placeholder="Перевод" dir="ltr">dir (post or get) * - directory 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> <div data-placeholder="Перевод" dir="ltr">php_version (post or get) - php version;</div> <div data-placeholder="Перевод" dir="ltr">bridge (post or get) - bridge;</div> <div data-placeholder="Перевод" dir="ltr">user_edit (post or get) - the name of the user being edited.</div> | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | error:0, mess:' | + | error:0, mess:'Domain edited successfully'; |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | error: | + | error:200, mess:'Domain edited successfully. Php is ***** by default. Available versions - ****'; |
− | error: | + | error:201, mess:'Domain edited successfully. the default bridge is *****. Available versions - ****'; |
− | error: | + | error:1, mess: 'Invalid username' |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
+ | error:100, mess:'Domain field must be filled'; | ||
+ | <div data-placeholder="Перевод" dir="ltr">error: 101, mess: 'The directory field must be filled';</div> <div data-placeholder="Перевод" dir="ltr">error: 102, mess: 'Domain already exists' or 'Alias already exists';</div> <div data-placeholder="Перевод" dir="ltr">error: 104, mess: 'The domain field is filled incorrectly. Please only use letters, numbers, dashes and periods';</div> <div data-placeholder="Перевод" dir="ltr">error: 104, mess: 'Alias fields are filled incorrectly. Please only use letters, numbers, dashes and dots';</div> <div data-placeholder="Перевод" dir="ltr">error: 105, mess: 'The directory field is incorrectly filled. Please only use letters, numbers, dashes and forward slashes. '</div> <div data-placeholder="Перевод" dir="ltr">error: 105, mess: 'The alias already exists in the main domain';</div> <div data-placeholder="Перевод" dir="ltr">error: 106, mess: 'Error while changing directory directory';</div> <div data-placeholder="Перевод" dir="ltr">error: 107, mess: 'No such bridge exists. Available bridges - **************** ';</div> <div data-placeholder="Перевод" dir="ltr">error: 108, mess: 'There is no such php version. Available versions - **************** ';</div> <div data-placeholder="Перевод" dir="ltr">error: 130, mess: 'This ip address does not belong to you';</div> <div data-placeholder="Перевод" dir="ltr">c: 400, mess: 'You don't have enough rights. Remove the user_edit 'field.</div> | ||
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
Line 178: | Line 56: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | List of domains. | |
list_domain | list_domain | ||
− | | 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">server_control (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">list_domain (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> |
− | username (post | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'List of domains received', domains [array domains];</div> <div data-placeholder="Перевод" dir="ltr">error :: 400, mess: 'You do not have sufficient rights. Remove the user_edit 'field.</div> |
− | |||
− | password (post | ||
− | |||
− | server_control (post | ||
− | |||
− | list_domain(post | ||
− | |||
− | user_edit (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, mess:' | ||
− | |||
− | error::400, mess:' | ||
− | |||
|} | |} | ||
− | + | Other useful articles: | |
− | {| style="width: | + | {| style="width: 1130px;" |
|- | |- | ||
− | | | + | | style="width: 319px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]''' |
− | | | + | | style="width: 363px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]''' |
− | | | + | | style="width: 426px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 319px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]''' |
− | | | + | | style="width: 363px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]''' |
− | | | + | | style="width: 426px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 319px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]''' |
− | | | + | | style="width: 363px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]''' |
− | | | + | | style="width: 426px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 319px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]''' |
− | | | + | | style="width: 363px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]''' |
− | | | + | | style="width: 426px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 319px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]''' |
− | | | + | | style="width: 363px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]''' |
− | | | + | | style="width: 426px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 319px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]''' |
− | | | + | | style="width: 363px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]''' |
− | | | + | | style="width: 426px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 319px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]''' |
− | | | + | | style="width: 363px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]''' |
− | | | + | | style="width: 426px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 319px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]''' |
− | | | + | | style="width: 363px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]''' |
− | | | + | | style="width: 426px;" | |
− | '''[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: 319px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]''' |
− | | | + | | style="width: 363px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]''' |
− | | | + | | style="width: 426px;" | |
− | '''[https://docs.brainycp.io/index.php/API:_FTP- | + | '''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 319px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]''' |
− | | | + | | style="width: 363px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]''' |
− | | | + | | style="width: 426px;" | |
− | '''[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>]''' |
|} | |} | ||
+ | <div id="gtx-trans" style="position: absolute; left: 279px; top: 1085px;"><div class="gtx-trans-icon"> </div> </div> |
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 |
server_control |
Add domain. add_domain |
username (post or get) * - username; password (post or get) * - user password; server_control (post or get) * - constant, module name; add_domain (post or get) * - constant, operation name; dir (post or get) * - directory name; domains (post or get) * - domain name; IP (post or get) * - IP address; language (post or get) - can take the value: en / ru (ru by default); php_version (post or get) - php version; bridge (post or get) - bridge; user_edit (post or get) * - the name of the user being edited. aliases (post или get)* — aliases
|
error: 0, mess: 'The domain was added successfully'; error: 200, mess: 'The domain was added successfully. Php is ***** by default. Available versions - **** '; error: 201, mess: 'The domain was added successfully. The default bridge is *****. Available versions - **** '; error: 1, mess: 'Invalid username'; error: 100, mess: 'The domain field must be filled'; error: 101, mess: 'The directory field must be filled'; error: 102, mess: 'The domain already exists'; error: 104, mess: 'The domain field is filled incorrectly'; Please only use letters, numbers, dashes and periods'; error: 105, mess: 'The directory field is filled incorrectly'; Please only use letters, numbers, dashes and slashes'; error: 400, mess: 'You do not have sufficient rights. Remove the field user_edit '; error: 105, mess: 'The directory field is filled incorrectly'; Please only use letters, numbers, dashes and forward slashes. '; error: 400, mess: 'You do not have sufficient rights. Remove the user_edit 'field.
|
server_control |
Delete domain remove_domain |
username (post or get) * - username; password (post or get) * - user password; server_control (post or get) * - constant, module name; remove_domain (post or get) * - constant, operation name; domains (post or get) * - domain name; 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. remove_folder(post или get) - delete directory 0 or 1 (default 0)
|
error: 0, mess: 'Domain deleted successfully'; error: 1, mess: 'Invalid username'; error: 2, mess: 'Domain not found'; error: 3, mess: 'The domain field must be filled'; error: 400, mess: 'You do not have sufficient rights. Remove the user_edit 'field.
|
server_control |
Edit domain edit_domain |
username (post or get) * - username; password (post or get) * - user password; server_control (post or get) * - constant, module name; edit_domain (post or get) * - constant, operation name; domains (post or get) * - domain name; dir (post or get) * - directory name; IP (post or get) * - IP address; language (post or get) - can take the value: en / ru (ru by default); php_version (post or get) - php version; bridge (post or get) - bridge; user_edit (post or get) - the name of the user being edited.
|
error:0, mess:'Domain edited successfully'; error:200, mess:'Domain edited successfully. Php is ***** by default. Available versions - ****'; error:201, mess:'Domain edited successfully. the default bridge is *****. Available versions - ****'; error:1, mess: 'Invalid username' error:100, mess:'Domain field must be filled'; error: 101, mess: 'The directory field must be filled'; error: 102, mess: 'Domain already exists' or 'Alias already exists'; error: 104, mess: 'The domain field is filled incorrectly. Please only use letters, numbers, dashes and periods'; error: 104, mess: 'Alias fields are filled incorrectly. Please only use letters, numbers, dashes and dots'; error: 105, mess: 'The directory field is incorrectly filled. Please only use letters, numbers, dashes and forward slashes. ' error: 105, mess: 'The alias already exists in the main domain'; error: 106, mess: 'Error while changing directory directory'; error: 107, mess: 'No such bridge exists. Available bridges - **************** '; error: 108, mess: 'There is no such php version. Available versions - **************** '; error: 130, mess: 'This ip address does not belong to you'; c: 400, mess: 'You don't have enough rights. Remove the user_edit 'field.
|
server_control |
List of domains. list_domain |
username (post or get) * - username; password (post or get) * - user password; server_control (post or get) * - constant, module name; list_domain (post or get) * - constant, operation name; user_edit (post or get) - the name of the user being edited.
|
error: 0, mess: 'List of domains received', domains [array domains]; error :: 400, mess: 'You do not have sufficient rights. Remove the user_edit 'field.
|
Other useful articles: