Skip to main content

Job

Manage the jobs in the queue. osapi controller endpoint get --name job shows the same.

Endpoint group​

Namejob
DescriptionManage the jobs in the queue

Methods (4)​

NAMEVERBPATHPERMISSIONOPERATION ID
listGET/api/jobjob:readGetJobs
getGET/api/job/{id}job:readGetJobByID
deleteDELETE/api/job/{id}job:writeDeleteJobByID
retryPOST/api/job/{id}/retryjob:writeRetryJobByID

Types (4)​

NAMEINPUTOUTPUT
listListInput { status, limit, offset }ListJobsResponse { total_items, status_counts, items }
getGetInput { id }JobDetailResponse { id, status, created, target, operation, hostname, updated_at, changed, error, result, responses, agent_states, timeline }
deleteDeleteInput { id }
retryRetryInput { id }CreateJobResponse { job_id, status, revision, timestamp }