Difference between revisions of "API: CRON"
(4 intermediate revisions by 2 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" | ||
|- | |- | ||
− | | < | + | | <div data-placeholder="Перевод" dir="ltr" id="tw-target-text">'''Module'''</div> |
− | | <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 15: | Line 11: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | List of CRON-tasks of the user (ID, time, command). | |
listcommcron | listcommcron | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | username (post)* — | + | username (post)* — Username; |
− | password (post)* — | + | password (post)* — User password; |
− | crontab (post)* — | + | crontab (post)* — constant, module name; |
− | listcommcron (post)* — | + | listcommcron (post)* — constant, operation type; |
− | language (post) | + | language (post) —can take a value: en/ru (by default ru); |
− | panel_user (post) — | + | panel_user (post) — ISP username, to which the operation is applied. |
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | error:0, mess:' | + | error:0, mess:'List opf cron tasks has been successfully received for the user: <name>'; |
− | error:1, mess:' | + | error:1, mess:'Nothing found for:' <name>'; |
− | error:1000, mess:' | + | error:1000, mess:'You don't have admin rights'; |
− | error:1001, mess:' | + | error:1001, mess:'This user is not found in ISP-panel:<user>'. |
|- | |- | ||
Line 46: | Line 42: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | Adding CRON-task for user. | |
+ | |||
+ | addcommcron | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | username (post)* — | + | username (post)* — Username; |
− | password (post)* — | + | password (post)* — User password; |
− | crontab (post)* — | + | crontab (post)* — constant, module name; |
− | addcommcron (post)* — | + | addcommcron (post)* — constant, operation type; |
− | cron_freq_minutes (post)* — | + | cron_freq_minutes (post)* — minutes in format crond; |
− | cron_freq_hours (post)* — | + | cron_freq_hours (post)* — hours in format crond; |
− | cron_freq_days (post)* — | + | cron_freq_days (post)* — days in format crond; |
− | cron_freq_months (post)* — | + | cron_freq_months (post)* — months in format crond; |
− | cron_freq_weekdays (post)* — | + | cron_freq_weekdays (post)* — weekdays in format crond; |
− | cron_command (post)* | + | cron_command (post)* —command for launching; |
− | language (post) — | + | language (post) — can take a value: en/ru (by default ru); |
− | panel_user (post) | + | panel_user (post) —ISP user name, to which the operation is applied. |
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | error:0, mess:' | + | error:0, mess:'New task crond has been added for user: <name>'; |
− | error:5, mess:' | + | error:5, mess:'Error in parameter block'; |
− | error:1, mess:' | + | error:1, mess:'Error in adding new task crond for user: <name>'; |
− | error:1000, mess:' | + | error:1000, mess:'You don't have admin rights'; |
− | error:1001, mess:' | + | error:1001, mess:'The user is not found in ISP-panel:<user>'. |
|- | |- | ||
Line 89: | Line 87: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | + | Deleting CRON-task. | |
delcommcron | delcommcron | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | username (post)* — | + | username (post)* — Username; |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | password (post)* — User password; | |
− | + | crontab (post)* — constant, module name; | |
− | + | delcommcron (post)* — constant, operation type; | |
− | + | id_command (post) * - Job id number (Array element number in the listcommcron method) | |
− | language (post) — | + | language (post) — can take a value: en/ru (by default ru); |
− | panel_user (post) — | + | panel_user (post) — ISP username to which the operation is applied. |
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | error:0, mess:' | + | error:0, mess:'Task cron has been deleted for user: <name>'; |
− | error:1, mess:' | + | error:1, mess:'Error in deleting task crond for user: <name>'; |
− | error:2, mess:' | + | error:2, mess:'Task cron with such parameters is not found for user: <name>'; |
− | error:5, mess:' | + | error:5, mess:'Error in parameter block'; |
− | error:1000, mess:' | + | error:1000, mess:'You don't have admin rights'; |
− | error:1001, mess:' | + | error:1001, mess:'The user is not found in ISP-panel:<user>'. |
|- | |- | ||
Line 141: | Line 129: | ||
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | username (post)* — | + | username (post)* — Username; |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | password (post)* — User password; | |
− | + | crontab (post)* — constant, module name; | |
− | + | editcommcron (post)* — constant, operation type; | |
− | + | cron_freq_minutes (post)* — minutes in format crond; | |
− | + | cron_freq_hours (post)* — hours in format crond; | |
− | + | cron_freq_days (post)* — days in format crond; | |
− | + | cron_freq_months (post)* — months in format crond; | |
− | + | cron_freq_weekdays (post)* — weekdays in format crond; | |
− | + | cron_command (post)* — command to perform; | |
− | + | id_command (post) * - Job id number (Array element number in the listcommcron method) | |
− | language (post) — | + | language (post) — can take a value: en/ru (by default ru); |
− | panel_user (post) — | + | panel_user (post) — ISP username to which the operation is applied. |
| style="vertical-align: top;" | | | style="vertical-align: top;" | | ||
− | error:0, mess:' | + | error:0, mess:'The crond task has been edited for user: <name>'; |
− | error:1, mess:' | + | error:1, mess:'error in editing the current task crond for user: <name>'; |
− | error:2, mess:' | + | error:2, mess:'The crond task with such parameters is not found for user:<username>'; |
− | error:4, mess:' | + | error:4, mess:'No cron job with id =' |
− | error:5, mess:' | + | error:5, mess:'Error in parameter block'; |
− | error:1000, mess:' | + | error:1000, mess:'You don't have admin rights'; |
− | error:1001, mess:' | + | error:1001, mess:'The user is not found in ISP-panel:<user>'. |
|} | |} | ||
− | + | Other useful articles: | |
− | {| style="width: | + | {| style="width: 1108px;" |
|- | |- | ||
− | | | + | | style="width: 346px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_connection <font><font>API: connection</font></font>]''' |
− | | | + | | style="width: 333px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Monitoring <font><font>API: monitoring</font></font>]''' |
− | | | + | | style="width: 407px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Webserver_status <font><font>API: web server status</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 346px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_CMS_Autoinstaller <font><font>API: auto installer CMS</font></font>]''' |
− | | | + | | style="width: 333px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Configuring_backups <font><font>API: configuring backups</font></font>]''' |
− | | | + | | style="width: 407px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Transfer_between_servers <font><font>API: transfer between servers</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 346px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Antivirus <font><font>API: antivirus</font></font>]''' |
− | | | + | | style="width: 333px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Server_configuration <font><font>API: server settings</font></font>]''' |
− | | | + | | style="width: 407px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Manage_webserver <font><font>API: web server management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 346px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Databases <font><font>API: database</font></font>]''' |
− | | | + | | style="width: 333px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_User_Certificates <font><font>API: custom certificates</font></font>]''' |
− | | | + | | style="width: 407px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Managing_mailboxes <font><font>API: mailbox management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 346px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Server_info <font><font>API: server information</font></font>]''' |
− | | | + | | style="width: 333px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Mail <font><font>API: mail</font></font>]''' |
− | | | + | | style="width: 407px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Manage_DNS-zones <font><font>API: DNS zone management</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 346px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Traffic_usage <font><font>API: traffic usage</font></font>]''' |
− | | | + | | style="width: 333px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Client_mail <font><font>API: client mailboxes</font></font>]''' |
− | | | + | | style="width: 407px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Webserver_Installation <font><font>API: web server installation</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 346px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Logging <font><font>API: logging</font></font>]''' |
− | | | + | | style="width: 333px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Nameserver <font><font>API: name server</font></font>]''' |
− | | | + | | style="width: 407px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_host-accounts <font><font>API: host accounts</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 346px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_App_manager <font><font>API: application manager</font></font>]''' |
− | | | + | | style="width: 333px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Certificates_of_services <font><font>API: service certificates</font></font>]''' |
− | | | + | | style="width: 407px;" | |
− | '''[https://docs.brainycp.io/index.php/API:_CRON API: CRON]''' | + | '''[https://docs.brainycp.io/index.php/API:_CRON <font><font>API: CRON</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 346px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Process_manager <font><font>API: process manager</font></font>]''' |
− | | | + | | style="width: 333px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Network_tools <font><font>API: network tools</font></font>]''' |
− | | | + | | style="width: 407px;" | |
− | '''[https://docs.brainycp.io/index.php/API:_FTP- | + | '''[https://docs.brainycp.io/index.php/API:_FTP-server <font><font>API: FTP server</font></font>]''' |
|- | |- | ||
− | | | + | | style="width: 346px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_IP-address_manager <font><font>API: IP address manager</font></font>]''' |
− | | | + | | style="width: 333px;" | |
− | '''[https://docs.brainycp.io/index.php/API: | + | '''[https://docs.brainycp.io/index.php/API:_Load_average <font><font>API: average load</font></font>]''' |
− | | | + | | style="width: 407px;" | |
− | '''[https://docs.brainycp.io/index.php/API:_MySQL_processlist API: MySQL processlist]''' | + | '''[https://docs.brainycp.io/index.php/API:_MySQL_processlist <font><font>API: MySQL processlist</font></font>]''' |
|} | |} |
Latest revision as of 15:27, 17 November 2021
Module
|
Function |
Incoming data |
Error variants |
crontab |
List of CRON-tasks of the user (ID, time, command). listcommcron |
username (post)* — Username; password (post)* — User password; crontab (post)* — constant, module name; listcommcron (post)* — constant, operation type; language (post) —can take a value: en/ru (by default ru); panel_user (post) — ISP username, to which the operation is applied. |
error:0, mess:'List opf cron tasks has been successfully received for the user: <name>'; error:1, mess:'Nothing found for:' <name>'; error:1000, mess:'You don't have admin rights'; error:1001, mess:'This user is not found in ISP-panel:<user>'. |
crontab |
Adding CRON-task for user. addcommcron |
username (post)* — Username; password (post)* — User password; crontab (post)* — constant, module name; addcommcron (post)* — constant, operation type; cron_freq_minutes (post)* — minutes in format crond; cron_freq_hours (post)* — hours in format crond; cron_freq_days (post)* — days in format crond; cron_freq_months (post)* — months in format crond; cron_freq_weekdays (post)* — weekdays in format crond; cron_command (post)* —command for launching; language (post) — can take a value: en/ru (by default ru); panel_user (post) —ISP user name, to which the operation is applied. |
error:0, mess:'New task crond has been added for user: <name>'; error:5, mess:'Error in parameter block'; error:1, mess:'Error in adding new task crond for user: <name>'; error:1000, mess:'You don't have admin rights'; error:1001, mess:'The user is not found in ISP-panel:<user>'. |
crontab |
Deleting CRON-task. delcommcron |
username (post)* — Username; password (post)* — User password; crontab (post)* — constant, module name; delcommcron (post)* — constant, operation type; id_command (post) * - Job id number (Array element number in the listcommcron method) language (post) — can take a value: en/ru (by default ru); panel_user (post) — ISP username to which the operation is applied. |
error:0, mess:'Task cron has been deleted for user: <name>'; error:1, mess:'Error in deleting task crond for user: <name>'; error:2, mess:'Task cron with such parameters is not found for user: <name>'; error:5, mess:'Error in parameter block'; error:1000, mess:'You don't have admin rights'; error:1001, mess:'The user is not found in ISP-panel:<user>'. |
crontab |
Редактирование CRON-задания. editcommcron |
username (post)* — Username; password (post)* — User password; crontab (post)* — constant, module name; editcommcron (post)* — constant, operation type; cron_freq_minutes (post)* — minutes in format crond; cron_freq_hours (post)* — hours in format crond; cron_freq_days (post)* — days in format crond; cron_freq_months (post)* — months in format crond; cron_freq_weekdays (post)* — weekdays in format crond; cron_command (post)* — command to perform; id_command (post) * - Job id number (Array element number in the listcommcron method) language (post) — can take a value: en/ru (by default ru); panel_user (post) — ISP username to which the operation is applied. |
error:0, mess:'The crond task has been edited for user: <name>'; error:1, mess:'error in editing the current task crond for user: <name>'; error:2, mess:'The crond task with such parameters is not found for user:<username>'; error:4, mess:'No cron job with id =' error:5, mess:'Error in parameter block'; error:1000, mess:'You don't have admin rights'; error:1001, mess:'The user is not found in ISP-panel:<user>'. |
Other useful articles: