Last modified November 7, 2024

manageSchedule

This function allows you to create/modify the Schedule Object.
Parameters
Parameter name Type Description Possible Values Example
_id String REQUIRED on action modify. The ID of the schedule N/A _id=5f890a19e55cf262863522f2
action String REQUIRED on both create/modify. The action you want to perform.
  • modify
  • create
action=create
type Integer REQUIRED on action create. The integer value for Schedule Type. Visit Schedule Types below for all possible values. type=1
type_data[]* List REQUIRED on action create. For Schedule Types: Daily, Monthly Visit Type Data below for all possible values. type_data[0]=1&type_data[1]=2&...
  Integer REQUIRED on action create. For Schedule Types: Hourly, Weekly Visit Type Data below for all possible values. type_data=1
  String REQUIRED on action create. For Schedule Types: After Backup Job id of the Backup Job you want to follow type_data=5f864533cde674169f42ffe2

Example Call JETAPI

jetbackup5api -F manageSchedule -D "action=create&name={$NAME}&jobs[0]={$BACKUP_JOB_ID}&type=2&type_data[0]=1&type_data[1]=2&type_data[2]=3&type_data[3]=4&type_data[4]=5&type_data[5]=6&type_data[6]=7"
success: 1 message: Schedule Created Successfully system: version: 5.3.3 version_panel: 5.3.3 tier: EDGE type: cPanel retry_ms: 0 disableui: dr: agreement_panel: agreement: licenseIssue: data: _id: 6505f00dea8aa76f3c0fe4a2 name: Daily 30 Retain type: 2 type_name: Daily type_data: 0: 1 1: 2 2: 3 3: 4 4: 5 5: 6 6: 7 delay_type: 1 delay_amount: 0 delay: 0 owner: 6503d48bfc45b1addf0a9632 owner_name: root count: 0 jobs:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=manageSchedule&action=create&name={$NAME}&jobs[0]={$BACKUP_JOB_ID}&type=2&type_data[0]=1&type_data[1]=2&type_data[2]=3&type_data[3]=4&type_data[4]=5&type_data[5]=6&type_data[6]=7