API: Transfer between servers
From BrainyCP
Revision as of 13:06, 26 July 2021 by Alenka (talk | contribs) (Protected "API: Transfer between servers" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
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 |
|
transfer |
Display the list of host-accounts on the remote server. list_user |
username (post or get) * - username; password (post or get) * - user password; transfer (post or get) * - constant, module name; list_user (post or get) * - constant, operation name; type (post or get) * - accepts the type of connection: password - connection when entering a password and login; key - connection with a private and public key. If password is selected: loginremote (post or get) * - login on the remote server; passremote (post or get) * - password on the remote server. When selecting key: key (post or get) * - private key via encodeURIComponent; loginremote (post or get) * - login on the remote server. ip (post or get) * - ip-address of the remote server; language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, mess: 'Getting the list of users from the remote host', detail [array_remote_host]; error: 100, mess: 'Type mismatch'; error: 101, mess: 'Invalid ip'; error: 102, mess: 'No remote login or password specified'; error: 103, mess: 'The ip key or login is not filled in'; error: 666, mess: 'You are trying to enter forbidden territory'; error: 400, mess: 'Unfortunately, the module is not available to you.'
|
|
transfer |
getting the list of ip-addresses on the remote server. list_ip |
username (post or get) * - username; password (post or get) * - user password; transfer (post or get) * - constant, module name; list_ip (post or get) * - constant, operation name; type (post or get) * - accepts the type of connection: password - connection when entering a password and login; key - connection with a private and public key. If password is selected: loginremote (post or get) * - login on the remote server; passremote (post or get) * - password on the remote server. When selecting key: key (post or get) * - private key via encodeURIComponent; loginremote (post or get) * - login on the remote server. ip (post or get) * - ip-address of the remote server; language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, mess: 'Getting ip list from remote host', detail [array_remote_ip]; error: 100, mess: 'Type mismatch'; error: 101, mess: 'Invalid ip'; error: 102, mess: 'No remote login or password specified'; error: 103, mess: 'The ip key or login is not filled in'; error: 666, mess: 'You are trying to enter forbidden territory'; error: 400, mess: 'Unfortunately, the module is not available to you.'
|
|
transfer |
Checking the connection with the remote server. connect |
username (post or get) * - username; password (post or get) * - user password; transfer (post or get) * - constant, module name; connect (post or get) * - constant, operation name; type (post or get) * - accepts the type of connection: password - connection when entering a password and login; key - connection with a private and public key. If password is selected: loginremote (post or get) * - login on the remote server; passremote (post or get) * - password on the remote server. When selecting key: key (post or get) * - private key via encodeURIComponent; loginremote (post or get) * - login on the remote server. ip (post or get) * - ip-address of the remote server; language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, mess: 'The connection to the remote server has been established'; error: 100, mess: 'Type mismatch'; error: 101, mess: 'Invalid ip'; error: 666, mess: 'You are trying to enter forbidden territory'; error: 400, mess: 'Unfortunately, the module is not available to you.'
|
|
transfer |
Generate and save key on the current server. key |
username (post or get) * - username; password (post or get) * - user password; transfer (post or get) * - constant, module name; key (post or get) * - constant, operation name; command (post or get) * - command 2 of the save, generate parameter: generate - generates public and private keys; save - saves the public and private key. When choosing save 2 options: key - public key (post or get) * via encodeURIComponent; private_key - private key (post or get) * via encodeURIComponent. language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, mess: 'Request completed', detail [key, privat_key]; error: 102, mess: 'One of the values of the private or public key is missing'; error: 666, mess: 'You are trying to enter forbidden territory'; error: 400, mess: 'Unfortunately, the module is not available to you.'
|
|
transfer |
Transfer of account to remote server and vise versa. start_trans |
username (post or get) * - username; password (post or get) * - user password; transfer (post or get) * - constant, module name; start_trans (post or get) * - constant, operation name; typetrans (post or get) * - where to transfer accounts: fromremote - from a remote server; toremote - to a remote server. ip (post or get) * - ip-address of the remote server; users_transfer [array] - an array of users or user (transfer via JSON.stringify); type (post or get) * - accepts the type of connection. When choosing password:
loginremote (post or get) * - login on the remote server; passremote (post or get) * - password on the remote server. When selecting key: key (post or get) * - private key via encodeURIComponent; loginremote (post or get) * - login on the remote server. domainsip (post or get) * - ip-address to which users are bound; language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, mess: 'Request completed', detail [key, privat_key]; error: 101, mess: 'Invalid transport type' (fromremote, toremote); error: 104, mess: 'Array of users was not transferred'; error: 103, mess: 'The ip key or login is not filled in'; error: 105, mess: 'The ip key or login is not filled in'; error: 102, mess: 'One of the values of the private or public key is missing'; error: 666, mess: 'You are trying to enter forbidden territory'; error: 400, mess: 'Unfortunately, the module is not available to you.'
|
|
transfer |
Transfer status. status_trans |
username (post or get) * - username; password (post or get) * - user password; transfer (post or get) * - constant, module name; status_trans (post or get) * - constant, operation name; language (post or get) - can take the value: en / ru (ru by default).
|
error: 0, mess: 'Request completed', detail [status_transfer]; error: 666, mess: 'You are trying to enter forbidden territory'; error: 400, mess: 'Unfortunately, the module is not available to you.'
|
Other useful articles:
