Jobs run tasks to completion. Omit schedule for on-demand jobs; include a cron expression to run on a schedule.
List jobs
Create a job
Define a task that runs to completion. Include a standard cron
expression in schedule to run on a recurring schedule. Omit it
for on-demand jobs that only run when manually triggered.
path Parameters
workspace_idproject_idCreate a job › Request Body
imagenamecommandscheduletagsCreate a job › Responses
Job created
messagestatusGet a job
Returns the job's configured spec: image, command, env vars, and schedule if present.
path Parameters
workspace_idproject_idjob_idGet a job › Responses
Job detail
messagestatusUpdate a job
Applies the updated configuration. Any field omitted from the request is left unchanged. Changes take effect on the next run.
path Parameters
workspace_idproject_idjob_idUpdate a job › Request Body
commandimagenamescheduletagsUpdate a job › Responses
Job updated
messagestatusDelete a job
Removes the job, all of its runs (including any in-flight), and the associated cron schedule if set. Irreversible.
path Parameters
workspace_idproject_idjob_idDelete a job › Responses
Deleted
datamessagestatusGet job logs
Returns logs across all runs of this job within the requested time window.
path Parameters
workspace_idproject_idjob_idquery Parameters
sincestartendlimitfilterGet job logs › Responses
Logs
messagestatusGet job metrics
Returns a batch of time series for the requested metrics. Pass a
comma-separated list in ?names=. Each metric's result is wrapped
with its own status so one failing query does not fail the whole
request.
Available metrics:
cpu_usage: average CPU across instances, in coresmemory_usage: total memory across instances, in bytes
path Parameters
workspace_idproject_idjob_idquery Parameters
namessincestartendGet job metrics › Responses
All metrics succeeded
messagestatusList runs
Returns every run of this job, ordered newest first. Includes both manually triggered runs and, for scheduled jobs, runs created by the cron schedule.
path Parameters
workspace_idproject_idjob_idList runs › Responses
List of runs
messagestatusTrigger a job run
Starts a new invocation of the job. Returns immediately with the run
record in pending state. Poll /runs/:run_id to observe state
transitions (pending, running, then one of succeeded, failed, or
cancelled).
path Parameters
workspace_idproject_idjob_idTrigger a job run › Responses
Run triggered
messagestatusGet a run
Returns a specific run's status, timing, exit code, and error message if any. Safe to poll. The backend is queried lazily so the response always reflects current state.
path Parameters
workspace_idproject_idjob_idrun_idGet a run › Responses
Run detail
messagestatusCancel a run
Stops an in-flight run and marks it cancelled. Only valid for runs
in pending or running state. Cancelling a run that has already
reached a terminal state returns an error.
path Parameters
workspace_idproject_idjob_idrun_idCancel a run › Responses
Cancelled
datamessagestatusGet run logs
Returns logs from a specific run of the job. Useful when a job has many historical runs and you need only the output of one invocation.
path Parameters
workspace_idproject_idjob_idrun_idquery Parameters
sincestartendlimitfilterGet run logs › Responses
Run logs
messagestatusGet job status
Returns the most recent run summary and aggregate run counts. For scheduled jobs, also includes the cron expression and the next scheduled fire time.
path Parameters
workspace_idproject_idjob_idGet job status › Responses
Status
messagestatus