Difference between revisions of "API: Webserver Installation"
From BrainyCP
m (Protected "API: Webserver Installation" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))) |
|||
| Line 13: | Line 13: | ||
Add domain. | 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"> | + | | 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;" | <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> | ||
|- | |- | ||
| Line 24: | Line 24: | ||
Delete domain | Delete domain | ||
| − | + | remove_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"> | + | | 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> |
| 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> | | 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> | ||
| | ||
| Line 41: | Line 41: | ||
| 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;" | <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:200, mess:' | + | error:200, mess:'Domain edited successfully. Php is ***** by default. Available versions - ****'; |
| − | error:201, mess:' | + | error:201, mess:'Domain edited successfully. the default bridge is *****. Available versions - ****'; |
| − | error:1, mess: ' | + | error:1, mess: 'Invalid username' |
| − | error:100, mess:' | + | 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> | <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> | ||
|- | |- | ||
| Line 61: | Line 61: | ||
| 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> | | 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> | ||
| − | | 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> | + | | 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> |
|} | |} | ||
Revision as of 13:25, 29 July 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:
