HomeGuidesAPI ReferenceChangelog
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Get all the scheduled jobs in Orchestrator

Return all the scheduled jobs.

"Minute schedule - Every minute starting at effectiveTime(in epoch sec )"
"schedule": {
"effectiveTime": 1431323520,
"recurrence": {
"minutes": 1
}
},


"Hourly Schedule - every seven hours starting from effectiveTime"
"schedule": {
"effectiveTime": 1431323520,
"recurrence": {
"hourly": 7
}
},


"Daily Schedule - every weekday at 2:03 am"
"
schedule": {
"effectiveTime": 1431968786,
"endTime": 1494435986,
"recurrence": {
"daily" : {
"everyWeekDay" : true,
"occursAt" : {
"hour": 2,
"minute": 3
}
}
},
"timezoneOffset": "-08:00"
},


"Daily Schedule - every day at 2:03 am"
"schedule": {
"effectiveTime": 1431323520,
"recurrence": {
"daily" : {
"everyDay" : true,
"occursAt" : {
"hour": 2,
"minute": 3
}
}
},
"timezoneOffset": "-08:00"
},


"Weekly Schedule - every sun, mon, tue and sat at 1:03 am. Timezone offset if the client offset"
"schedule": {
"effectiveTime": 1431323520,
"recurrence": {
"weekly": {
"daysOfTheWeek": [1,2,3,7],
"occursAt" : {
"hour": 1,
"minute": 3
}
}
},
"timezoneOffset": "-08:00"
},


"Monthly Schedule - every 2nd day of every 3 months at 12:06 pm. Timezone offset if the client offset"
"schedule": {
"effectiveTime": 1431323520,
"recurrence": {
"monthly": {
"type3": {
"day": 2,
"everyXMonths": 3
},
"occursAt" : {
"hour": 12,
"minute": 6
}
}
},
"timezoneOffset": "-08:00"
},


"Monthly Schedule - First Tue of every 4 months at 12:06 pm. Rank - 1,2,3,4 dayOfTheWeek - 1 (Sun), 2(Mon)...7(Sat)"
"schedule": {
"effectiveTime": 1431323520,
"recurrence": {
"monthly": {
"type4" : {
"rank": 1,
"dayOfTheWeek": 3,
"everyXMonths": 4
},
"occursAt" : {
"hour": 12,
"minute": 6
}
}
},
"timezoneOffset": "-08:00"
},


"Monthly Schedule - First day of every month at 12:00 pm"
"schedule": {
"effectiveTime": 1431323520,
"recurrence": {
"monthly": {
"type1" : {
"firstDayOfEveryMonth": true
},
"occursAt" : {
"hour": 12,
"minute": 0
}
}
},
"timezoneOffset": "-7:00"
},


"Monthly Schedule - Last day of every month at 12:00 pm"
"schedule": {
"effectiveTime": 1431323520,
"recurrence": {
"monthly": {
"type2" : {
"lastDayOfEveryMonth": true
},
"occursAt" : {
"hour": 12,
"minute": 0
}
}
},
"timezoneOffset": "-7:00"
},


"Yearly Schedule - Jan 2nd every year at 12:02 pm. month - 1(Jan), 2(Feb)..."
"schedule": {
{
"effectiveTime": 12234343,
"recurrence" : {
"yearly": {
"type1": {
"month": 1,
"day": 2
}
"occursAt" : {
"hour": 12,
"minute": 2
}
}
}
},
"timezoneOffset": "-7:00"
},


"Yearly Schedule - 1st Monday of Jan every year at 12:02 pm. rank - 1,2,3,4 dayOfTheWeek - 1(Sun), 2(Mon)... 7(Sat) month - 1(Jan), 2(Feb)..."
"schedule": {
{
{
"effectiveTime": 12234343,
"recurrence" : {
"yearly": {
"type2: {
"rank": 1,
"dayOfTheWeek": 2
"month": 1
}
"occursAt" : {
"hour": 12,
"minute": 2
}
}
}
},
"timezoneOffset": "-7:00"
},


"Run now job schedule"
"schedule": {
"runNow": true
}

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

Job id

boolean

If set to true, return all currently running job details

integer

Filter currently running jobs by job category. Identifies the type of job.
1 = TestJob,
2 = Orchestrator Report,
3 = Orchestrator Backup,
4 = Appliance Reboot/Shutdown,
5 = Appliance QOS Scheduling,
6 = IPsec Pre-shared Key Rotation,
7 = ikeless Seed Rotation,
8 = Auto MTU Discover,
9 = Check Point IPsec Preshared Key Rotation,
10 = Azure Get Data,
11 = Check Point Get Data

integer

Filter currently running jobs by job type.
1 = User defined job and
2 = System job

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*