Create a new scheduled job in Orchestrator

post

http://127.0.0.1:8080/gms/job

Creates and schedules a new job in the Orchestrator. Only user-defined job categories can be created via API. The job is immediately scheduled in Quartz if enabled. Requires READ_WRITE role.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Scheduled job configuration including category, schedule, and target appliances.

Request body for creating a new scheduled job via POST.

jobCategory

integer

enum

required

Job category identifier. Only user-defined categories allowed: 2=Report, 3=Backup, 4=Reboot/Shutdown, 5=QOS Scheduling, 8=Auto MTU Discover. System categories (1, 6, 7, 10-16, 20-24) cannot be created via API.

Allowed:

schedule

object

required

Defines when and how often the job should run. Must specify either effectiveTime OR runNow (not both).

config

object

required

Job-specific configuration object. Structure varies by jobCategory. For Report jobs, must include granularity settings.

description

string

length ≤ 255

Human-readable description of the job purpose. Optional but recommended.

targetAppliance

object

Specifies which appliances or groups the job will target.

enabled

boolean

Defaults to true

Whether the job should be active immediately after creation. Default is true.

Responses

401

Unauthorized - Authentication required.

403

Forbidden - User lacks READ_WRITE role.

Language

Loading…

Response

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

text/html

200Job created successfully. Returns the new job ID.

400Bad Request - Validation failed for the job configuration.