API: Server configuration
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 |
|
properties |
Server properties at the time of request execution (date and time, time zone, hostname, language, etc.).
getproper |
username (post or get) * - username; password (post or get) * - user password; properties (post or get) * - constant, module name; getproperties (post or get) * - constant, operation type; language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, mess: 'Information was received successfully'; error: 1, mess: 'An error occurred while receiving information'; error: 1000, mess: 'You do not have administrator rights'. If done correctly, the array will contain the following elements: [time], [locale], [hostname], [tz_date], [tz_time], [tz_time_m], [tz_time_s], [tz_time_h], [tz_timezone], [timezone_path], [timezone_name], [tz_sync]
|
|
properties |
Change time. settimeproper |
username (post or get) * - username; password (post or get) * - user password; properties (post or get) * - constant, module name; settimeproperties (post or get) * - constant, operation type; date (post or get) * - new time in the format 'Dec 14 00:05:00 EST 2016'; language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, mess: 'New date was set successfully'; error: 1, mess: 'New time has been set'; error: 1000, mess: 'You do not have administrator rights'.
|
|
properties |
Change time zone. settzproper |
username (post or get) * - username; password (post or get) * - user password; properties (post or get) * - constant, module name; settzproper (post or get) * - constant, operation type; tz (post or get) * - new time zone. For example, EST or WET; language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, mess: 'Time zone changed successfully'; error: 1, mess: 'An error occurred while changing the time zone'; error: 2, mess: 'The specified time zone is invalid'; error: 1000, mess: 'You do not have administrator rights'.
|
|
properties |
Change Hostname. sethostnameproper |
username (post or get) * - username; password (post or get) * - user password; properties (post or get) * - constant, module name; sethostnameproper (post or get) * - constant, operation type; hostname (post or get) * - new hostname; language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, mess: 'New hostname set'; error: 1, mess: 'An error occurred while setting a new hostname'; error: 2, mess: 'Invalid hostname'; error: 1000, mess: 'You do not have administrator rights'.
|
|
properties |
Change root-password. changerootpassprop |
username (post or get) * - username; password (post or get) * - user password; properties (post or get) * - constant, module name; changerootpassprop (post or get) * - constant, operation name; rootps (post or get) * - new password for root; language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, mess: 'Root password changed successfully'; error: 1, mess: 'An error occurred while changing the root password'; error: 2, mess: 'The new root password is too short, at least 8 characters'; error: 1000, mess: 'You do not have administrator rights'
|
|
properties |
Change brainysql-password. changebrainysqlpassproper |
username (post or get) * - username; password (post or get) * - user password; properties (post or get) * - constant, module name; changebrainysqlpassproper (post or get) * - constant, operation name; rootps (post or get) * - new password for brainysql; language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, mess: 'The password for brainysql has been successfully changed; error: 1, mess: 'An error occurred while changing the password for brainysql'; error: 2, mess: 'The new password for brainysql is too short, at least 8 characters'; error: 1000, mess: 'You do not have administrator rights'.
|
|
properties |
Change language. changelangproper |
username (post or get) * - username; password (post or get) * - user password; properties (post or get) * - constant, module name; changelangproper (post or get) * - constant, operation name; lang (post or get) * - setting the language ('ru' or 'en'); language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, mess: 'The selected language has been successfully installed'; error: 2, mess: 'Invalid language parameter specified'; error: 1000, mess: 'You do not have administrator rights'.
|
|
properties |
Change data for sending mails by panel. changetypemailproper |
username (post or get) * - username; password (post or get) * - user password; properties (post or get) * - constant, module name; changetypemailproper (post or get) * - constant, operation name: type (post or get) * - mail sender (smtp or phpmail); language (post or get) - can take the value: en / ru (ru by default). if 'type' = smtp, then the following parameters are requested: smtp_user (post or get) * - mailbox on behalf of whom the authentication is going on; smtp_pass (post or get) * - password for this user; smtp_port (post or get) * - smtp port; smtp_host (post or get) * - hostname of the smtp service; encoding (post or get) - encoding; smtp_from (post or get) - sender's name; smtp_headers - headers. if 'type' = phpmail, then the following parameters are requested: smtp_headers (post or get) - headers.
|
error: 0, mess: 'New parameters have been successfully applied'; error: 2, mess: 'The specified mailbox is invalid'; error: 3, mess: 'The specified hostname is invalid'; error: 4, mess: 'The port is not defined or it is invalid'; error: 1000, mess: 'You do not have administrator rights'.
|
Other useful articles:
