manageSchedule

Description

With this function, you can create/manage schedule.

Parameters

Parameter name Type Description Possible values Example
_id String Required on action modify
The ID of the schedule.
  5b697f04d5ac5e665e77c982
action String Required
The action you want to perform.
  • create
  • modify
 
name String Required on action create
Schedule name.
  monthly
type String Required on action create
Schedule Type.
To view the possible values click on Schedule Type  
typedata Integer/String/List hourly/weekly - Integer, The hour/day you want to run the job.
After Clone Job Done/After Backup Job Done - String, The id of the jobs.
daily/monthly - List of strings, The days you want to run the job.
To view the possible values click on Type Data hourly/weekly - 1
After Clone Job Done/After Backup Job Done - 5b5ef3a2d5ac5e30cc1d4ef2
daily/monthly - typedata[]=1&typedata[]=7&typedata[]=14&typedata[]=21&typedata[]=28
delayamount Integer
Schedule delay amount.
Exsist for After Backup/Clone/cPanel job is done Schedule Type.
   
delaytype String
Schedule delay type.
Exsist for After Backup/Clone/cPanel job is done Schedule Type.
  • minutes
  • hours
  • days
minutes

Returns

This API call returns schedule object.
To view the parameters that returned click on Schedule Object

Example