Skip to main content

Tasks - cancel a task

DELETE 

/api/v1/tasks/:taskId

Cancels a waiting or queued task. Has no effect on completed/failed tasks.

Request

Responses

Task cancelled

Reference

DELETE /api/v1/tasks/{taskId}

Cancels a waiting or queued task. Has no effect on completed/failed tasks.

Parameters

ParameterInTypeRequiredDescription
taskIdpathstringyesTask ID

Responses

StatusDescription
200Task cancelled
404Not found

Example request

curl -X DELETE "https://api.bitbybit.dev/api/v1/tasks/{taskId}" \
-H "x-api-key: YOUR_API_KEY"

Authentication: send your key in the x-api-key header. The full machine-readable specification is at openapi.json.