Skip to content

Cancel an extraction backfill

POST
/admin/metadata-extraction/backfills/{id}/cancel

Requests cancellation of a backfill’s coordinator.

You need to be signed in with system.admin for the whole install; a permission held only for a team doesn’t count. Success returns 204 with no body. Runs that already completed or were already cancelled are left unchanged. A run that doesn’t exist when the server checks for it returns 404.

The worker checks for cancellation between batches, not before each asset, so a batch in progress can still queue jobs after your request. Jobs already queued carry on; cancelling doesn’t stop them or undo the values they extract.

204 means the request was handled, not that the worker has stopped. If cancellation races the final batch, the coordinator can still finish and record completed_at alongside cancelled_at.

id
required
string format: uuid

UUID of the backfill run to cancel.

Cancellation was recorded, or the existing run was already cancelled or completed. No response body.

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Authenticated but missing required capabilities

object
error
required

Human-readable error summary

string
Example
the request could not be completed

Resource not found

object
error
required

Human-readable error summary

string
Example
the request could not be completed