Schedules

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[]=1&type_data[]=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

listSchedules

This function lists all Schedule Objects.

More Info

**Returns**
Parameter name	Type	Description	Possible Values	Example
schedules	List []	List of all Schedule Objects.
total	Integer	Total number of Schedule Objects.

Example Call JETAPI

jetbackup5api -F listSchedules

success: 1
message:
system:
version: 5.3.3
version_panel: 5.3.3
tier: EDGE
type: cPanel
retry_ms: 0
disableui:
dr:
agreement_panel:
agreement:
licenseIssue:
data:
schedules:
        0:
        _id: 64f37dd1347bd676126b3302
        name: hourly
        type: 1
        type_name: Hourly
        type_data: 1
        delay_type: 1
        delay_amount: 0
        delay: 0
        owner: 64f37d695aa01f55661b38f2
        owner_name: root
        count: 1
        jobs:
                0:
                _id: 64f37dd2b740ce5d5e1c01f2
                name: Backup: job

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=listSchedules

To view available listing parameters, please visit List Parameters.
API List calls have a default limit of 100 items.

getSchedule

This function prints the objects data given its Schedule ID.

More Info

**Parameters**
Parameter name	Type	Description	Possible Values	Example
_id	String	REQUIRED The Schedule ID		`_id=5f890a19e55cf262863522f2`

Returns the data for Schedule Object.

Example Call JETAPI

jetbackup5api -F getSchedule -D "_id={$SCHEDULE_ID}"

success: 1
message:
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: 64f37dd1347bd676126b3302
name: hourly31132
type: 1
type_name: Hourly
type_data: 1
delay_type: 1
delay_amount: 0
delay: 0
owner: 64f37d695aa01f55661b38f2
owner_name: root
count: 1
jobs:
        0:
        _id: 64f37dd2b740ce5d5e1c01f2
        name: Backup: test

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=getSchedule&_id={$SCHEDULE_ID}

deleteSchedule

This function allows you to delete the object given its Schedule ID.

More Info

**Parameters**
Parameter name	Type	Description	Possible Values	Example
_id	String	REQUIRED The Schedule ID		`_id=5f890a19e55cf262863522f2`

Example Call JETAPI

jetbackup5api -F deleteSchedule -D "_id={$SCHEDULE_ID}"

success: 1
message: Schedule Deleted 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:

Example Call HTTP

https://hostname.example.com:2087/cpsess##########/cgi/addons/jetbackup5/api.cgi?function=deleteSchedule&_id={$SCHEDULE_ID}

Parameter Dictionary

Schedule Object

Parameter name Type Description Possible Values Example

_id String The Schedule ID. 5f8a21545108792bb859b1a3

name String The name assigned to Schedule by user. 'Daily Schedule'

type

Integer

The type of schedule.

Hourly	1
Daily	2
Weekly	3
Monthly	4
After Backup Done	5

type_name String The corresponding name for the schedule type. Daily

type_data List[]/Integer/String The Type Data for each type of schedule. Can be list of integers for Daily/Monthly, integer for Hourly/Weekly, or string for AfterBackupJob.

delay_type

Integer

The unit for delay. To view all possible types visit Delay Type

Minutes	1
Hours	2
Days	3

delay_amount Integer Amount to delay by. Enter the amount as a positive integer. 0 amount will run the backup job immediately after the assigned job completes. delay_amount=0

delay Boolean Value indicating if there is a delay. 1/0

owner String ID of the owner of the schedule.

owner_name String Name of the owner

count Integer Number of jobs schedule is assigned to.

jobs List [] List of Backup Jobs schedule is assigned to.

Type Data

Type Name Description Possible Values Examples

Hourly

Can only assign one value for Hourly Schedules.

Every 1 Hour	1
Every 2 Hours	2
Every 3 Hours	3
Every 4 Hours	4
Every 6 Hours	6
Every 8 Hours	8
Every 12 Hours	12

type_data=4 sets the schedule to run every 4 hours.

Daily

Can assign multiple values for Daily Schedules.

Sunday	1
Monday	2
Tuesday	3
Wednesday	4
Thursday	5
Friday	6
Saturday	7

type_data[0]=1&type_data[1]=5 sets the schedule to run every Sunday and Thursday.

Weekly

Can only assign one value for Weekly Schedules.

Sunday	1
Monday	2
Tuesday	3
Wednesday	4
Thursday	5
Friday	6
Saturday	7

type_data=3 sets the schedule to run every week on Tuesday.

Monthly

Can assign multiple values for Monthly Schedules.

1st of the Month	1
7th of the Month	7
14th of the Month	14
21st of the Month	21
28th of the Month	28

type_data[0]=1&type_data[1]=21 sets the schedule to run every 1st and 21st of the Month.

After Backup Done Can only assign one Backup Job for After BackupJob Done Schedules. Have to assign the Delay Type as well. Backup Job ID type_data=5fd44aebb0d87e31a47cfed2 sets the schedule to run after the Backup Job 5fd44aebb0d87e31a47cfed2 completes.

JETAPI Documentation

On This Page:

Schedules

manageSchedule

listSchedules

getSchedule

deleteSchedule

Parameter Dictionary

Schedule Object

Type Data

On This Page: