Difference between revisions of "API: Manage webserver"

From BrainyCP
Jump to: navigation, search
 
(One intermediate revision by the same user not shown)
Line 13: Line 13:
 
set_password
 
set_password
  
| 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">apacserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">set_password (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">directory (post or get) * - directory;</div> <div data-placeholder="Перевод" dir="ltr">password (post) * - password;</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>  
+
| 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">apacserver (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">set_password (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">directory (post or get) * - directory;</div> <div data-placeholder="Перевод" dir="ltr">password (post) * - password directory;</div> <div data-placeholder="Перевод" dir="ltr">user_login(post) * - login directory;</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>  
 
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Success';</div> <div data-placeholder="Перевод" dir="ltr">error: -1, mess: 'The directory does not exist or the format is invalid';</div> <div data-placeholder="Перевод" dir="ltr">error: -1, mess: 'Weak password';</div> <div data-placeholder="Перевод" dir="ltr">error: -2, mess: 'The password for this folder already exists';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.</div>  
 
| style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Success';</div> <div data-placeholder="Перевод" dir="ltr">error: -1, mess: 'The directory does not exist or the format is invalid';</div> <div data-placeholder="Перевод" dir="ltr">error: -1, mess: 'Weak password';</div> <div data-placeholder="Перевод" dir="ltr">error: -2, mess: 'The password for this folder already exists';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.</div>  
 
|-
 
|-
Line 120: Line 120:
 
Other useful articles:
 
Other useful articles:
  
{| style="width: 1227px;"
+
{| style="width: 1237px;"
 
|-
 
|-
| style="width: 364px;" |  
+
| style="width: 330px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]'''
  
| style="width: 394px;" |  
+
| style="width: 454px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]'''
  
| style="width: 447px;" |  
+
| style="width: 431px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]'''
  
 
|-
 
|-
| style="width: 364px;" |  
+
| style="width: 330px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]'''
  
| style="width: 394px;" |  
+
| style="width: 454px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]'''
  
| style="width: 447px;" |  
+
| style="width: 431px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]'''
  
 
|-
 
|-
| style="width: 364px;" |  
+
| style="width: 330px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]'''
  
| style="width: 394px;" |  
+
| style="width: 454px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]'''
  
| style="width: 447px;" |  
+
| style="width: 431px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]'''
  
 
|-
 
|-
| style="width: 364px;" |  
+
| style="width: 330px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]'''
  
| style="width: 394px;" |  
+
| style="width: 454px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]'''
  
| style="width: 447px;" |  
+
| style="width: 431px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]'''
  
 
|-
 
|-
| style="width: 364px;" |  
+
| style="width: 330px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]'''
  
| style="width: 394px;" |  
+
| style="width: 454px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]'''
  
| style="width: 447px;" |  
+
| style="width: 431px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]'''
  
 
|-
 
|-
| style="width: 364px;" |  
+
| style="width: 330px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]'''
  
| style="width: 394px;" |  
+
| style="width: 454px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]'''
  
| style="width: 447px;" |  
+
| style="width: 431px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]'''
  
 
|-
 
|-
| style="width: 364px;" |  
+
| style="width: 330px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]'''
  
| style="width: 394px;" |  
+
| style="width: 454px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]'''
  
| style="width: 447px;" |  
+
| style="width: 431px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]'''
  
 
|-
 
|-
| style="width: 364px;" |  
+
| style="width: 330px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]'''
  
| style="width: 394px;" |  
+
| style="width: 454px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]'''
  
| style="width: 447px;" |  
+
| style="width: 431px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]'''
  
 
|-
 
|-
| style="width: 364px;" |  
+
| style="width: 330px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]'''
  
| style="width: 394px;" |  
+
| style="width: 454px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]'''
  
| style="width: 447px;" |  
+
| style="width: 431px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]'''
  
 
|-
 
|-
| style="width: 364px;" |  
+
| style="width: 330px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]'''
  
| style="width: 394px;" |  
+
| style="width: 454px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]'''
  
| style="width: 447px;" |  
+
| style="width: 431px;" |  
 
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]'''
 
'''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]'''
  
 
|}
 
|}

Latest revision as of 13:57, 18 August 2023

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

apacserver

Setting a password for a directory.

set_password

username (post or get) * - username;
password (post or get) * - user password;
apacserver (post or get) * - constant, module name;
set_password (post or get) * - constant, operation name;
directory (post or get) * - directory;
password (post) * - password directory;
user_login(post) * - login directory;
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: 'Success';
error: -1, mess: 'The directory does not exist or the format is invalid';
error: -1, mess: 'Weak password';
error: -2, mess: 'The password for this folder already exists';
error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.

apacserver

Removing a directory

.

delete_password

username (post or get) * - username;
password (post or get) * - user password;
apacserver (post or get) * - constant, module name;
delete_password (post or get) * - constant, operation name;
directory (post or get) * - directory;
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: 'Success';
error: -1, mess: 'Not completed';
error: 100, mess: 'The directory does not exist or the format is invalid';
error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.

apacserver

Browse password-protected directories.

list_directory

username (post or get) * - username;
password (post or get) * - user password;
apacserver (post or get) * - constant, module name;
list_directory (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 password-protected directories', detail [array_directory];
error: 100, mess: 'The list of password-protected directories is empty';
error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.

apacserver

Redirect from http to https / https to http.

add_http

username (post or get) * - username;
password (post or get) * - user password;
apacserver (post or get) * - constant, module name;
add_http (post or get) * - constant, operation name;
site (post or get) * - domain for redirection;
type (post or get) * - type of redirection (http, https);
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: 'Forwarding added successfully';
error: -1, mess: 'This type of forwarding already exists;
error: -1, mess: 'A redirect already exists for this site .;
error: 100, mess: 'This is not yours', detail [list_domain;
error: 101, mess: 'Non-existent type', detail [array_type];
error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.

apacserver

Show list of sites.

list_http

username (post or get) * - username;
password (post or get) * - user password;
apacserver (post or get) * - constant, module name;
list_http (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 domains', detail [array_domain];
error: 100, mess: 'The list of domains is empty';
error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.

apacserver

Listing directories.

list_directory_http

username (post or get) * - username;

password (post or get) * - user password;

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

list_directory_http (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 Directories', detail [array_directory];
error: 100, mess: 'Directory List is empty';
error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.

apacserver

Delete directory.

delete_http

username (post or get) * - username;
password (post or get) * - user password;
apacserver (post or get) * - constant, module name;
delete_http (post or get) * - constant, operation name;
site (post or get) * - domain (redirect to be deleted);
uniq_id (post or get) * - unique identifier;
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: 'Forwarding successfully deleted';
error: -1, mess: 'There are no rights for this operation!';
error: 100, mess: 'This is not yours';
error: 400, message: 'You do not have sufficient rights. Remove user_edit '.

apacserver

Display a list of redirects.

list_www

username (post or get) * - username;
password (post or get) * - user password;
apacserver (post or get) * - constant, module name;
list_www (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, message: 'Forwarding list', detail [array_forwarding];
error: 100, message: 'The forwarding list is empty';
error: 400, message: 'You do not have sufficient rights. Remove user_edit '.

apacserver

Delete redirect

delete_www

username (post or get) * - username;
password (post or get) * - user password;
apacserver (post or get) * - constant, module name;
delete_www (post or get) * - constant, operation name;
uniq_id (post or get) * - uical identifier (needed for deletion);
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: 'Forwarding successfully deleted';
error: -1, mess: 'There are no rights for this operation!';
error: 100, mess: 'The unic_id was entered incorrectly. Or this redirection is no longer there ';
error: 400, mess: 'You do not have sufficient rights. Remove user_edit '.

apacserver

Web-redirect

add_www

username (post or get) * - username;
password (post or get) * - user password;
apacserver (post or get) * - constant, module name;
add_www (post or get) * - constant, operation name;
domain (post) * - domain;
select_www (post or get) * - redirect method;
site_forwarding (post) * - where the redirect leads;
src (post or get) * - path for forwarding;
draft (post or get) - false by default;
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: 'Forwarding added successfully';
error: -1, mess: 'This type of forwarding already exists';
error: -1, mess: 'Invalid destination format';
error: -1, mess: 'Invalid site name format';
error: -1, mess: 'There are no rights for this operation!';
error: 101, mess: 'Domain does not exist.', detail [array_list_domain];
error: 102, mess: 'Forwarding assigned incorrectly', detail [array_list_forwarding];
error: 103, mess: 'No forwarding path specified'.

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