Difference between revisions of "API: CRON"

From BrainyCP
Jump to: navigation, search
m (Protected "API: CRON" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
 
(2 intermediate revisions by the same user not shown)
Line 43: Line 43:
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
 
Adding CRON-task for user.
 
Adding CRON-task for user.
 +
 +
addcommcron
  
 
| style="vertical-align: top;" |  
 
| style="vertical-align: top;" |  
Line 98: Line 100:
 
delcommcron (post)* — constant, operation type;
 
delcommcron (post)* — constant, operation type;
  
−
cron_freq_minutes (post)* — minutes in format crond;
+
id_command (post) * - Job id number (Array element number in the listcommcron method)
−
 
 
−
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;
 
  
 
language (post) — can take a value: en/ru (by default ru);
 
language (post) — can take a value: en/ru (by default ru);
Line 157: Line 149:
 
cron_command (post)* — command to perform;
 
cron_command (post)* — command to perform;
  
−
cron_new_minutes (post) — new minutes in format crond;
+
id_command (post) * - Job id number (Array element number in the listcommcron method)
−
 
 
−
cron_new_hours (post) — new 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;
 
  
 
language (post) — can take a value: en/ru (by default ru);
 
language (post) — can take a value: en/ru (by default ru);
Line 180: Line 162:
 
error:2, mess:'The crond task with such parameters is not found for user:<username>';
 
error:2, mess:'The crond task with such parameters is not found for user:<username>';
  
−
error:4, mess:'New values are not set. Nothing to perform'
+
error:4, mess:'No cron job with id ='
  
 
error:5, mess:'Error in parameter block';
 
error:5, mess:'Error in parameter block';
Line 192: Line 174:
 
Other useful articles:
 
Other useful articles:
  
−
{| style="width: 1191px;"
+
{| style="width: 1108px;"
 
|-
 
|-
−
|  
+
| style="width: 346px;" |  
−
'''[https://docs.brainycp.io/index.php/API:_подключение 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:_мониторинг 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:_статус_веб-сервера 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:_автоустановщик_CMS API: автоустановщик CMS]'''
+
'''[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:_настройка_бекапов 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:_трансфер_между_серверами 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:_антивирус 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:_настройки_сервера 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:_управление_веб-сервером 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:_базы_данных 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:_пользовательские_сертификаты 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:_управление_почтовыми_ящиками 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:_информация_о_сервере 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:_почта 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:_управление_DNS-зонами API: управление DNS-зонами]'''
+
'''[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:_использование_трафика 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:_почтовые_ящики_клиента 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:_установка_веб-сервера 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:_логирование 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:_сервер_имен 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:_хост-аккаунты 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:_менеджер_приложений 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:_сертификаты_сервисов 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:_менеджер_процессов 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:_сетевые_инструменты 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-сервер 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:_менеджер_IP-адресов API: менеджер IP-адресов]'''
+
'''[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:_средняя_нагрузка 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

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

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:

API: connection

API: monitoring

API: web server status

API: auto installer CMS

API: configuring backups

API: transfer between servers

API: antivirus

API: server settings

API: web server management

API: database

API: custom certificates

API: mailbox management

API: server information

API: mail

API: DNS zone management

API: traffic usage

API: client mailboxes

API: web server installation

API: logging

API: name server

API: host accounts

API: application manager

API: service certificates

API: CRON

API: process manager

API: network tools

API: FTP server

API: IP address manager

API: average load

API: MySQL processlist

Retrieved from "https://docs.brainycp.io/index.php?title=API:_CRON&oldid=1953"