Retrieve scheduled jobs from Orchestrator

get

http://127.0.0.1:8080/gms/job

Returns scheduled jobs based on filter criteria. When no parameters are provided, returns all scheduled jobs with previous fire times. Use id to get a specific job, currentlyRunningJob to filter running jobs, or noPreFireTime for faster retrieval without previous fire time calculation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

integer

≥ 1

Unique job identifier. When provided, returns only the job with this ID. If the job doesn't exist, returns 400 Bad Request.

currentlyRunningJob

boolean

Defaults to false

When true, returns only jobs that are currently executing. Can be combined with jobCategory and jobType filters. Default is false.

noPreFireTime

boolean

Defaults to false

When true, skips fetching previous fire time from Quartz scheduler for faster response. Default is false.

jobCategory

integer

enum

Filter jobs by category type. Only applies when currentlyRunningJob=true. Valid values: 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, 10=Azure Get Data, 11=Check Point Get Data, 12=Zscaler Get Data, 13=AWS TGNM Get Data, 14=IDS/IPS Signature Downloader, 15=ClearPass Policy Manager, 16=Stats Collector Backup, 20=IP Objects Merging, 21=Netskope Get Data, 22=HPE SSE Get Data, 23=Azure LAN Get Data, 24=SSE Connector Matrix.

jobType

integer

enum

Filter jobs by type. Only applies when currentlyRunningJob=true. Values: 1=User-defined job (created via API), 2=System job (auto-created by Orchestrator).

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized - Authentication required. User must have READ or READ_WRITE role.

403

Forbidden - User lacks required permissions.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/html

200Array of scheduled jobs matching the filter criteria. Returns empty array if no jobs match.

400Bad Request - Invalid job ID or validation error.