Difference between revisions of "API: Transfer between servers"
From BrainyCP
(5 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
| | ||
− | + | <div data-placeholder="Перевод" dir="ltr">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.</div> <div data-placeholder="Перевод" dir="ltr">Incoming data marked with an asterisk are required.</div> | |
− | |||
− | |||
− | |||
− | |||
{| border="1" cellpadding="5" | {| border="1" cellpadding="5" | ||
|- | |- | ||
− | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''Module'''</p> |
− | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''Function'''</p> |
− | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''Incoming data'''</p> |
− | | <p dir="ltr" style="text-align: center;">''' | + | | <p dir="ltr" style="text-align: center;">'''Error variants'''</p> |
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
Line 17: | Line 13: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | Display the list of host-accounts on the remote server. | |
list_user | list_user | ||
− | | style="vertical-align: top;" | | + | | 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">transfer (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">list_user (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">type (post or get) * - accepts the type of connection:</div> <div data-placeholder="Перевод" dir="ltr">password - connection when entering a password and login;</div> <div data-placeholder="Перевод" dir="ltr">key - connection with a private and public key.</div> <div data-placeholder="Перевод" dir="ltr">If password is selected:</div> <div data-placeholder="Перевод" dir="ltr">loginremote (post or get) * - login on the remote server; passremote (post or get) * - password on the remote server.</div> <div data-placeholder="Перевод" dir="ltr">When selecting key:</div> <div data-placeholder="Перевод" dir="ltr">key (post or get) * - private key via encodeURIComponent; loginremote (post or get) * - login on the remote server.</div> <div data-placeholder="Перевод" dir="ltr">ip (post or get) * - ip-address of the remote server;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div> |
− | username (post | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Getting the list of users from the remote host', detail [array_remote_host];</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'Type mismatch';</div> <div data-placeholder="Перевод" dir="ltr">error: 101, mess: 'Invalid ip';</div> <div data-placeholder="Перевод" dir="ltr">error: 102, mess: 'No remote login or password specified';</div> <div data-placeholder="Перевод" dir="ltr">error: 103, mess: 'The ip key or login is not filled in';</div> <div data-placeholder="Перевод" dir="ltr">error: 666, mess: 'You are trying to enter forbidden territory';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div> |
− | |||
− | password (post | ||
− | |||
− | transfer (post | ||
− | |||
− | list_user (post | ||
− | |||
− | type (post | ||
− | |||
− | |||
− | |||
− | key | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | ip (post | ||
− | |||
− | language (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, mess:' | ||
− | |||
− | error:100, mess:' | ||
− | |||
− | error:101, mess:' | ||
− | |||
− | error:102, mess:' | ||
− | |||
− | error:103, mess:' | ||
− | |||
− | error:666, mess:' | ||
− | |||
− | error:400, mess:' | ||
− | |||
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
Line 68: | Line 24: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | getting the list of ip-addresses on the remote server. | |
list_ip | list_ip | ||
− | | style="vertical-align: top;" | | + | | 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">transfer (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">list_ip (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">type (post or get) * - accepts the type of connection:</div> <div data-placeholder="Перевод" dir="ltr">password - connection when entering a password and login;</div> <div data-placeholder="Перевод" dir="ltr">key - connection with a private and public key.</div> <div data-placeholder="Перевод" dir="ltr">If password is selected:</div> <div data-placeholder="Перевод" dir="ltr">loginremote (post or get) * - login on the remote server;</div> <div data-placeholder="Перевод" dir="ltr">passremote (post or get) * - password on the remote server.</div> <div data-placeholder="Перевод" dir="ltr">When selecting key:</div> <div data-placeholder="Перевод" dir="ltr">key (post or get) * - private key via encodeURIComponent;</div> <div data-placeholder="Перевод" dir="ltr">loginremote (post or get) * - login on the remote server.</div> <div data-placeholder="Перевод" dir="ltr">ip (post or get) * - ip-address of the remote server;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div> |
− | username (post | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Getting ip list from remote host', detail [array_remote_ip];</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'Type mismatch';</div> <div data-placeholder="Перевод" dir="ltr">error: 101, mess: 'Invalid ip';</div> <div data-placeholder="Перевод" dir="ltr">error: 102, mess: 'No remote login or password specified';</div> <div data-placeholder="Перевод" dir="ltr">error: 103, mess: 'The ip key or login is not filled in';</div> <div data-placeholder="Перевод" dir="ltr">error: 666, mess: 'You are trying to enter forbidden territory';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div> |
− | |||
− | password (post | ||
− | |||
− | transfer (post | ||
− | |||
− | list_ip (post | ||
− | |||
− | type (post | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | ip (post | ||
− | |||
− | language (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, mess:' | ||
− | |||
− | error:100, mess:' | ||
− | |||
− | error:101, mess:' | ||
− | |||
− | error:102, mess:' | ||
− | |||
− | error:103, mess:' | ||
− | |||
− | error:666, mess:' | ||
− | |||
− | error:400, mess:' | ||
− | |||
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
Line 123: | Line 35: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | Checking the connection with the remote server. | |
connect | connect | ||
− | | style="vertical-align: top;" | | + | | 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">transfer (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">connect (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">type (post or get) * - accepts the type of connection:</div> <div data-placeholder="Перевод" dir="ltr">password - connection when entering a password and login;</div> <div data-placeholder="Перевод" dir="ltr">key - connection with a private and public key.</div> <div data-placeholder="Перевод" dir="ltr">If password is selected:</div> <div data-placeholder="Перевод" dir="ltr">loginremote (post or get) * - login on the remote server;</div> <div data-placeholder="Перевод" dir="ltr">passremote (post or get) * - password on the remote server.</div> <div data-placeholder="Перевод" dir="ltr">When selecting key:</div> <div data-placeholder="Перевод" dir="ltr">key (post or get) * - private key via encodeURIComponent;</div> <div data-placeholder="Перевод" dir="ltr">loginremote (post or get) * - login on the remote server.</div> <div data-placeholder="Перевод" dir="ltr">ip (post or get) * - ip-address of the remote server;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div> |
− | username (post | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'The connection to the remote server has been established';</div> <div data-placeholder="Перевод" dir="ltr">error: 100, mess: 'Type mismatch';</div> <div data-placeholder="Перевод" dir="ltr">error: 101, mess: 'Invalid ip';</div> <div data-placeholder="Перевод" dir="ltr">error: 666, mess: 'You are trying to enter forbidden territory';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div> |
− | |||
− | password (post | ||
− | |||
− | transfer (post | ||
− | |||
− | connect (post | ||
− | |||
− | type (post | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | ip (post | ||
− | |||
− | language (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, mess:' | ||
− | |||
− | error:100, mess:' | ||
− | |||
− | error:101, mess:' | ||
− | |||
− | error:666, mess:' | ||
− | |||
− | error:400, mess:' | ||
− | |||
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
Line 174: | Line 46: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | Generate and save key on the current server. | |
key | key | ||
− | | style="vertical-align: top;" | | + | | 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">transfer (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">key (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">command (post or get) * - command 2 of the save, generate parameter:</div> <div data-placeholder="Перевод" dir="ltr">generate - generates public and private keys;</div> <div data-placeholder="Перевод" dir="ltr">save - saves the public and private key.</div> <div data-placeholder="Перевод" dir="ltr">When choosing save 2 options:</div> <div data-placeholder="Перевод" dir="ltr">key - public key (post or get) * via encodeURIComponent;</div> <div data-placeholder="Перевод" dir="ltr">private_key - private key (post or get) * via encodeURIComponent.</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div> |
− | username (post | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Request completed', detail [key, privat_key];</div> <div data-placeholder="Перевод" dir="ltr">error: 102, mess: 'One of the values of the private or public key is missing';</div> <div data-placeholder="Перевод" dir="ltr">error: 666, mess: 'You are trying to enter forbidden territory';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div> |
− | |||
− | password (post | ||
− | |||
− | transfer (post | ||
− | |||
− | key (post | ||
− | |||
− | command (post | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | language (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, mess:' | ||
− | |||
− | error:102, mess:' | ||
− | |||
− | error:666, mess:' | ||
− | |||
− | error:400, mess:' | ||
− | |||
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
Line 215: | Line 57: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | Transfer of account to remote server and vise versa. | |
start_trans | start_trans | ||
− | | style="vertical-align: top;" | | + | | 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">transfer (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">start_trans (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">typetrans (post or get) * - where to transfer accounts:</div> <div data-placeholder="Перевод" dir="ltr">fromremote - from a remote server;</div> <div data-placeholder="Перевод" dir="ltr">toremote - to a remote server.</div> <div data-placeholder="Перевод" dir="ltr">ip (post or get) * - ip-address of the remote server;</div> <div data-placeholder="Перевод" dir="ltr">users_transfer [array] - an array of users or user (transfer via JSON.stringify);</div> <div data-placeholder="Перевод" dir="ltr">type (post or get) * - accepts the type of connection.</div> <div data-placeholder="Перевод" dir="ltr">When choosing password:</div> |
− | username (post | + | |
− | + | <div data-placeholder="Перевод" dir="ltr">loginremote (post or get) * - login on the remote server;</div> <div data-placeholder="Перевод" dir="ltr">passremote (post or get) * - password on the remote server.</div> <div data-placeholder="Перевод" dir="ltr">When selecting key:</div> <div data-placeholder="Перевод" dir="ltr">key (post or get) * - private key via encodeURIComponent;</div> <div data-placeholder="Перевод" dir="ltr">loginremote (post or get) * - login on the remote server.</div> <div data-placeholder="Перевод" dir="ltr">domainsip (post or get) * - ip-address to which users are bound;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div> | |
− | password (post | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Request completed', detail [key, privat_key];</div> <div data-placeholder="Перевод" dir="ltr">error: 101, mess: 'Invalid transport type' (fromremote, toremote);</div> <div data-placeholder="Перевод" dir="ltr">error: 104, mess: 'Array of users was not transferred';</div> <div data-placeholder="Перевод" dir="ltr">error: 103, mess: 'The ip key or login is not filled in';</div> <div data-placeholder="Перевод" dir="ltr">error: 105, mess: 'The ip key or login is not filled in';</div> <div data-placeholder="Перевод" dir="ltr">error: 102, mess: 'One of the values of the private or public key is missing';</div> <div data-placeholder="Перевод" dir="ltr">error: 666, mess: 'You are trying to enter forbidden territory';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div> |
− | |||
− | transfer (post | ||
− | |||
− | start_trans (post | ||
− | |||
− | typetrans (post | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | ip (post | ||
− | |||
− | users_transfer[array] | ||
− | |||
− | type (post | ||
− | |||
− | |||
− | |||
− | | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | domainsip (post | ||
− | |||
− | language (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, mess:' | ||
− | |||
− | error:101, mess:' | ||
− | |||
− | error:104, mess:' | ||
− | |||
− | error:103, mess:' | ||
− | |||
− | error:105, mess:' | ||
− | |||
− | error:102, mess:' | ||
− | |||
− | error:666, mess:' | ||
− | |||
− | error:400, mess:' | ||
− | |||
|- | |- | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
Line 278: | Line 70: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | Transfer status. | |
status_trans | status_trans | ||
− | | style="vertical-align: top;" | | + | | 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">transfer (post or get) * - constant, module name;</div> <div data-placeholder="Перевод" dir="ltr">status_trans (post or get) * - constant, operation name;</div> <div data-placeholder="Перевод" dir="ltr">language (post or get) - can take the value: en / ru (ru by default).</div> |
− | username (post | + | | style="vertical-align: top;" | <div data-placeholder="Перевод" dir="ltr">error: 0, mess: 'Request completed', detail [status_transfer];</div> <div data-placeholder="Перевод" dir="ltr">error: 666, mess: 'You are trying to enter forbidden territory';</div> <div data-placeholder="Перевод" dir="ltr">error: 400, mess: 'Unfortunately, the module is not available to you.'</div> |
− | |||
− | password (post | ||
− | |||
− | transfer (post | ||
− | |||
− | status_trans (post | ||
− | |||
− | language (post | ||
− | |||
− | | style="vertical-align: top;" | | ||
− | error:0, mess:' | ||
− | |||
− | error:666, mess:' | ||
− | |||
− | error:400, mess:' | ||
− | |||
|} | |} | ||
− | + | Other useful articles: | |
− | {| style="width: | + | {| style="width: 1061px;" |
|- | |- | ||
− | | | + | | style="width: 282px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]''' |
− | | | + | | style="width: 354px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]''' |
− | | | + | | style="width: 403px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 282px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]''' |
− | | | + | | style="width: 354px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]''' |
− | | | + | | style="width: 403px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 282px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]''' |
− | | | + | | style="width: 354px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]''' |
− | | | + | | style="width: 403px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 282px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]''' |
− | | | + | | style="width: 354px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]''' |
− | | | + | | style="width: 403px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 282px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]''' |
− | | | + | | style="width: 354px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]''' |
− | | | + | | style="width: 403px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 282px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]''' |
− | | | + | | style="width: 354px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]''' |
− | | | + | | style="width: 403px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 282px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]''' |
− | | | + | | style="width: 354px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]''' |
− | | | + | | style="width: 403px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 282px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]''' |
− | | | + | | style="width: 354px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]''' |
− | | | + | | style="width: 403px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 282px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]''' |
− | | | + | | style="width: 354px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]''' |
− | | | + | | style="width: 403px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 282px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]''' |
− | | | + | | style="width: 354px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]''' |
− | | | + | | style="width: 403px;" | |
− | '''[https://docs.brainycp. | + | '''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]''' |
|} | |} |
Latest revision as of 14:36, 17 November 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 |
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: