API: Webserver Installation
From BrainyCP
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_zones |
username (post or get) * - username; password (post or get) * - user password; server_control (post or get) * - constant, module name; add_zones (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.
|
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_zones |
username (post or get) * - username; password (post or get) * - user password; server_control (post or get) * - constant, module name; remove_zones (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.
|
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:'Домен успешно отредактирован'; error:200, mess:'Домен успешно отредактирован. Php по умолчанию - *****. Доступные версии - ****'; error:201, mess:'Домен успешно отредактирован. мост по умолчанию - *****. Доступные версии - ****'; error:1, mess: 'Неверное имя пользователя' error:100, mess:'Поле домен должно быть заполненным'; 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: