Database endpoints
Cancel a background job
Stop a filtered update or delete job. Changes already applied are not rolled back.
POST /v1/tenants/{tenant}/vector-indexes/{index}/jobs/{job_id}/cancel
- Locate the running jobUse the ID from the filtered update or delete.
- Request cancellationA 202 response acknowledges the request.
- Recheck job progressInspect its final state and work already completed.
Before you start
Use your database bearer token.
Use the job ID returned by a filtered vector-record update or delete. Cancelling does not undo completed work.
Path parameters
| Field | Type | Required |
|---|---|---|
tenant | string | Required |
index | string | Required |
job_id | string | Required |
Headers
| Field | Type | Required | Description |
|---|---|---|---|
x-oc-db-user | string | Optional | Acting database user (role, grant and row-policy checks). Send with x-oc-db-key. |
x-oc-db-key | string | Optional | API key of the x-oc-db-user user. |
Read the result
The 202 response acknowledges the cancellation request and has no documented response body. Check the job afterward. Cancellation does not undo changes that the job already applied.
Response statuses
HTTP status reference
| Status | What to do |
|---|---|
| 202 | Accepted |
| 400 | Correct the request before retrying. |
| 401 | Check the credential and Authorization header. |
| 402 | Check feature access or available credits. |
| 403 | Check tenant access, roles and permissions. |
| 404 | Check the resource ID and API route. |
| 409 | Resolve the conflict before retrying. |
| 429 | Honor Retry-After when present; back off. |
| 500 | Check the outcome before retrying a write. |
| 501 | Check deployment support for this operation. |
| 503 | Honor Retry-After when present; check write outcomes. |