Scheduled jobs
Recurring work the platform runs for a workspace: when each job runs, what a workspace changes about that, and what every run did.
List scheduled jobs
Platform jobs with this workspace's overrides applied, plus its own jobs.
query Parameters
cursor^[A-Za-z0-9_-]+$job_scopejob_titlejob_typelimitoffsetsort^-?[a-z0-9_]+$Headers
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List scheduled jobs › Responses
Success
has_moreWhether more rows exist past this page.
next_cursorPass back as cursor for the next page. Null on the last page.
Get a scheduled job
Returns one job with its schedule and what the workspace has changed about it.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get a scheduled job › Responses
Success
job_idjob_managed_byjob_activejob_createdjob_updatedjob_namejob_titlejob_descriptionjob_cronjob_timezonejob_typejob_workflowjob_configjob_scopejob_max_retriesjob_timeout_secondsjob_metadataoverride_idoverride_enabledoverride_cronoverride_timezoneoverride_configlast_run_statuslast_run_atSet a job override
Changes the schedule for this workspace only. The platform job is untouched.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Set a job override › Request Body optional
job_tenant_enabledjob_tenant_cronjob_tenant_timezoneSet a job override › Responses
Success
Delete a job override
The job goes back to the platform schedule.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Delete a job override › Responses
Success
Run a job now
Runs it for this workspace only, without affecting the schedule or anyone else.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Run a job now › Responses
Success
List job runs
Returns what every run of this job did, newest first.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List job runs › Responses
Success