– Schedules

Jb5: manageSchedule

Mon, 01 Jan 0001 00:00:00 +0000

Parameter name Type Description Possible Values Example

action

String

REQUIRED on both create/modify. The action you want to perform.

modify
create

action=create

_id String REQUIRED on action modify. The ID of the schedule _id=5f890a19e55cf262863522f2

name String REQUIRED on action create. The Name of the schedule name=hourly schedule

type

Integer

REQUIRED on action create. The integer value for Schedule Type.

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

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&...

type_data Integer REQUIRED on action create. For Schedule Types: Hourly, Weekly Visit Type Data below for all possible values. type_data=1

type_data String REQUIRED on action create. For Schedule Types: After Backup Job ID of the Backup Job you want to follow type_data=5f864533cde674169f42ffe2

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_type

String

The Delay type for the schedule. Only for After Backup/Clone Jobs Done.

Minutes	1
Hours	2
Days	3

delay_type=1

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

Jb5: listSchedules

Mon, 01 Jan 0001 00:00:00 +0000

**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.

Jb5: getSchedule

Mon, 01 Jan 0001 00:00:00 +0000

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

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}

Jb5: deleteSchedule

Mon, 01 Jan 0001 00:00:00 +0000

**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}