job-scheduler
Manage item job scheduling (run, cancel, schedules)
Authentication scope: fabric
list-instances
Section titled “list-instances”List job instances for an item
fabio job-scheduler list-instances --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Item ID |
Read-only · Returns list
get-instance
Section titled “get-instance”Show details of a job instance
fabio job-scheduler get-instance --workspace <value> --id <value> --job-instance-id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Item ID |
--job-instance-id |
string |
Yes | Job instance ID |
Read-only · Returns object
run-on-demand
Section titled “run-on-demand”Run an on-demand job for an item
fabio job-scheduler run-on-demand --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Item ID |
--job-type |
string |
No | Job type (e.g., DefaultJob, RunNotebook, Pipeline, TableMaintenance, SparkJob) Default: DefaultJob. |
--execution-data |
string |
No | Execution data as JSON (optional, depends on job type) |
--wait |
bool |
No | Wait for the job to complete (polls until finished) |
--timeout |
u64 |
No | Maximum time to wait in seconds (default: 600). Only used with –wait Default: 600. |
--cancel-on-timeout |
bool |
No | Cancel the job if –wait times out (default: leave running) |
Mutates state · Long-running operation · Returns object
cancel-instance
Section titled “cancel-instance”Cancel a running job instance
fabio job-scheduler cancel-instance --workspace <value> --id <value> --job-instance-id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Item ID |
--job-instance-id |
string |
Yes | Job instance ID |
Mutates state · Returns object
list-schedules
Section titled “list-schedules”List schedules for an item job type
fabio job-scheduler list-schedules --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Item ID |
--job-type |
string |
No | Job type (e.g., DefaultJob, RunNotebook, Pipeline) Default: DefaultJob. |
Read-only · Returns list
get-schedule
Section titled “get-schedule”Show details of a specific schedule
fabio job-scheduler get-schedule --workspace <value> --id <value> --schedule-id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Item ID |
--job-type |
string |
No | Job type |
--schedule-id |
string |
Yes | Schedule ID |
Read-only · Returns object
create-schedule
Section titled “create-schedule”Create a schedule for an item job type
fabio job-scheduler create-schedule --workspace <value> --id <value> --config <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Item ID |
--job-type |
string |
No | Job type |
--enabled |
bool |
No | Whether the schedule is enabled |
--config |
string |
Yes | Schedule configuration object as JSON. Required fields: type (Cron|Daily|Weekly|Monthly), startDateTime, endDateTime, localTimeZoneId; plus per-type: Cron→interval, Daily→times[], Weekly→times[]+weekdays[]. Example: ‘{“type”:“Cron”,“startDateTime”:“2026-01-01T00:00:00”,“endDateTime”:“2026-12-31T23:59:00”,“localTimeZoneId”:“UTC”,“interval”:10}’ |
Mutates state · Returns object
update-schedule
Section titled “update-schedule”Update an existing schedule
fabio job-scheduler update-schedule --workspace <value> --id <value> --schedule-id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Item ID |
--job-type |
string |
No | Job type |
--schedule-id |
string |
Yes | Schedule ID |
--enabled |
enum |
No | Whether the schedule is enabled One of: true, false. |
--config |
string |
No | Updated schedule configuration as JSON |
Mutates state · Returns object
delete-schedule
Section titled “delete-schedule”Delete a schedule
fabio job-scheduler delete-schedule --workspace <value> --id <value> --schedule-id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Item ID |
--job-type |
string |
No | Job type |
--schedule-id |
string |
Yes | Schedule ID |
Mutates state · Destructive · Returns void