Skip to main content

Delete Job

Soft-delete a job. The record is marked deleted (via a deleted_at timestamp) and excluded from list and get endpoints, but its files and result data are retained. To permanently remove files or data, use Hard Delete Job.

DELETE /v1/jobs/{job_id}

Authentication​

  • Authentication is required. Include a valid df_ API key in the Authorization header, or rely on the machine-local default credential. See Authentication.

Path Parameters​

ParameterTypeDescription
job_idnumber(int)The edge job id to soft-delete.

Behaviour​

A job can only be soft-deleted once it has reached a terminal state, complete or error (completed/failed are also accepted). Attempting to delete a queued or processing job returns 422.


Response​

{
"status": true,
"code": 200,
"message": "Job soft deleted",
"data": {
"job_id": 42,
"deleted": true
}
}

Errors​

CodeCondition
404No job exists with the given id.
422The job is not in a complete/error terminal state.

Example Request​

curl -X DELETE http://<edge-host>:9123/v1/jobs/42 \
-H "Authorization: Bearer df_..."