Cancel a bulk-action job
Cancels a bulk-action job and returns it. Items the job already processed stay processed. A job that has already finished is left as it is.
bearerAuthAuthorizationBearer <token>Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).
id*stringThe ID of the bulk-action job.
X-Marfa-Instance-Id?stringThe ID of the instance you expect, as GET / returns it. If another instance answers at this address, Marfa returns 409 instance_changed and doesn't write. Leave it out to send the request to whichever instance answers.
^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$Returns the job: canceled if it was queued or running, otherwise its final state unchanged.
application/json- response
A bulk action Marfa runs in the background, with its progress.
id*stringUnique identifier for the job.
action*stringThe action, such as purge.
status*stringWhere the job is.
"queued""in_progress""completed""failed""canceled"matched*integerHow many items the job acts on, fixed when Marfa queued it.
processed*integerHow many of the matched items the job has reached so far, changed or not.
succeeded*integerHow many items the job has changed so far.
errored*integerHow many items the job has left unchanged so far.
started_at?stringWhen the job started running, in UTC. Absent until then.
finished_at?stringWhen the job completed, failed or was canceled, in UTC. Absent until then.
error?stringWhy the job failed, for a person to read. Present only when status is failed.
result?What the job did. Present once status is completed or failed.
validation_error: the query has a parameter this endpoint doesn't take.
application/json- response
An error response.
error*What went wrong.
unauthorized: the request has no credential, or its credential is not valid. For a key that has expired, details.expired_at says when it expired.
application/json- response
An error response.
error*What went wrong.
forbidden: another credential queued the job, and yours lacksinstance.maintain.
application/json- response
An error response.
error*What went wrong.
bulk_job_not_found: no job has this ID.
application/json- response
An error response.
error*What went wrong.
instance_changed: X-Marfa-Instance-Id names another instance. Nothing is written. Rebuild the working copy from the instance at this address.
application/json- response
An error response.
error*What went wrong.
contract_mismatch: X-Marfa-Contract names another contract version than this instance speaks, or is not a whole number. Nothing was done.
application/json- response
An error response.
error*What went wrong.
request_too_large: the request body is larger than this instance accepts.
application/json- response
An error response.
error*What went wrong.
rate_limited: you sent too many requests. Wait for the number of seconds in Retry-After, then try again.
application/json- response
An error response.
error*What went wrong.
internal_error: Marfa failed in a way it didn't expect, and the request may not have completed. Read what you changed before you repeat a write.
application/json- response
An error response.
error*What went wrong.
write_contention: the database was busy, and Marfa couldn't complete the request in time. Nothing changed. Try the request again. While a restore runs, details.reason is restore_running.
application/json- response
An error response.
error*What went wrong.
insufficient_storage: the disk that holds the instance's data has no room for the request, or the request would leave less free than the instance keeps in reserve. Nothing changed, unless details.write_outcome is unknown, which means the write may have landed: read what you changed before you repeat it. Free space on the disk, then try the request again.
application/json- response
An error response.
error*What went wrong.
curl -X POST 'http://localhost:8600/items/bulk-actions/jobs/string/cancel'{ "id": "01a1011d-9881-7a06-919f-a8ab9d27b80d", "action": "update_tags", "status": "canceled", "matched": 3, "processed": 3, "succeeded": 3, "errored": 0, "started_at": "2026-10-03T09:52:05.085Z", "finished_at": "2026-10-03T09:54:05.816Z"}