WARNING: JetBackup 4 is set to reach its End-of-Life (EOL) on July 1st, 2024. For More Information, please visit: JetBackup 4 EOL Announcement.
NOTICE: JetBackup 5 is now available in the Stable Tier. For more information, please visit our Jetbackup 5 Documentation.

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 After Clone Job Done/After Backup Job Done (Backup Job ID) - typedata=5b5ef3a2d5ac5e30cc1d4ef2
Hourly/Weekly - typedata=3
Daily/Monthly - typedata[]=1&typedata[]=4&typedata[]=7
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 returned, click on Schedule Object

Example

jetapi backup -F manageSchedule -D '_id=5b697f04d5ac5e665e77c982&action=modify&name=monthly'

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup/api.cgi?function=manageSchedule&_id=5b697f04d5ac5e665e77c982&action=modify&name=monthly