jobs

Cancel a running job

Changed on

<b>Beta:</b> Cancel a job that is still running. Checks already in flight stop being processed and the job moves to cancelled. This does not delete the job: GET /v1/jobs/{job_id} keeps returning its status and the progress counts reached before the cancellation. A cancelled job never produces a results file, so GET /v1/jobs/{job_id}/results returns 409 for it.

delete/v1/jobs/{job_id}

Request

  • Base URL
    https://coverage-api.meetnirvana.com
  • URL
    https://coverage-api.meetnirvana.com/v1/jobs/{job_id}
  • Auth
    none declared

Path parameters

job_idstring required

Response

Successful Response

completedinteger required
failedinteger required
in_processinteger required
job_idstring required
results_urlstring required

Results endpoint for this job. Returns a download link once the job has completed.

status'running' | 'completed' | 'failed' | 'cancelled' required
status_urlstring required

Poll this URL for the current job status and progress counts.

totalinteger required

Changes