v1

latestOpenAPI 3.1.0MIT2026-07-1799111346.8 KB

Get job status

Returns timing, success state, output, and progress for a specific job.

post/job/status

Query parameters

jobidnumber

Numeric identifier of the job to query, as returned from an async call.

_asyncboolean

Run the command asynchronously. Returns a job id immediately.

Headers

Prefer'respond-async'

Set to "respond-async" with _async=true to receive HTTP 202 instead of 200.

Request body

jobidnumber

Numeric identifier of the job to query, as returned from an async call.

_asyncboolean

Run the command asynchronously. Returns a job id immediately.

Response

Detailed status for a background job, including timing, success flag, and optional output.

finishedboolean required

True once the job has completed.

durationnumber required

Execution time in seconds.

endTimestring required

Timestamp when the job finished. (e.g. '2025-12-26T18:50:20.528746884+01:00')

errorstring required

Error message, or empty string on success.

idnumber required

Job identifier.

startTimestring required

Timestamp when the job started. (e.g. '2025-12-24T18:50:20.5281314+01:00')

successboolean required

True if the job completed successfully.

{"stackTrail":"components:responses:JobStatusResponse:content:application/json:schema:properties:output","oasType":"schema","type":"unknown","description":"Synchronous-style output payload when available."}

{"stackTrail":"components:responses:JobStatusResponse:content:application/json:schema:properties:progress","oasType":"schema","type":"unknown","description":"Progress measurements supplied by the underlying command."}