Cron administration functions

getList

Description:

Method returns list of all CronTab tasks.

Call example:
https://api.beget.de/api/cron/getList?login=userlogin&
passwd=password&output_format=json
Response example:
 [
   {
     "row_number": "1000", // task ID
     "minutes": "*",       // Minutes
     "hours": "*",         // Hours
     "days": "*",          // Days
     "months": "10,11",    // Months
     "weekdays": "*",      // Weekdays
     "command": "wget -O \/dev\/null http:\/\/wget vk.com", // Command
     "is_hidden": "1"      // task status (active/inactive)
   }
 ]

Returns twodimensional array, each string whereof describes a Cron task.

add

Description:

Method adds new task. Task will be active upon adding.

Additional parameters
  • minutes - minutes;
  • hours - hours;
  • days - days;
  • months - months;
  • weekdays - weekdays;
  • command - command;
Call example:
// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/cron/add?login=userlogin&
passwd=password&input_format=json&output_format=json&input_data=
{"minutes":"*","hours":"*","days":"*","months":"*","weekdays":"*",
"command":"wget -O \/dev\/null http:\/\/wget vk.com"}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/cron/add?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22minutes%22%3A%22*%22%2C%22hours%22%3A
%22*%22%2C%22days%22%3A%22*%22%2C%22months%22%3A%22*%22
%2C%22weekdays%22%3A%22*%22%2C%22command%22%3A%22wget%20-O
%20%5C%2Fdev%5C%2Fnull%20http%3A%5C%2F%5C%2Fwget%20vk.com%22%7D
Response example:
 "row_number": 1000

Returns task ID (task ID is unique within one user).

delete

Description:

Method will delete task with given ID.

Additional parameters
  • row_number - ID задания, тип int;
Call example:
// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/cron/delete?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data={"row_number":1000}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/cron/delete?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22row_number%22%3A1000%7D
Response example:
 true

Returns property of successful or unsuccessful execution.

changeHiddenState

Description:

Method will change task status.

Additional parameters
  • row_number - task ID , type int;
  • is_hidden - task status (active / inactive), type boolean: 0 or 1;
Call example:
// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/cron/changeHiddenState?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data={"row_number":1000,"is_hidden":0}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/cron/changeHiddenState?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22row_number%22%3A1000%2C%22is_hidden%22%3A0%7D
Response example:
 "row_number": 4

Returns new task ID (the task identifier is unique within one user).

getEmail

Description:

Method returns email, where the display of executed tasks is sent.

Call example:
https://api.beget.de/api/cron/getEmail?login=userlogin&
passwd=password&output_format=json
Response example:
 admin@domain.de

If no email has been set, method returns NULL.

setEmail

Description:

Method sets email, where the display of executed tasks will be sent.

Additional parameters
  • email - Email or empty string;
Call example:
// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/cron/setEmail?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data={"email":"admin@domain.de"}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/cron/setEmail?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22email%22%3A%22admin%40domain.de%22%7D
Response example:
 true

Returns property of successful or unsuccessful execution.