Check a background job

GET /v1/tenants/{tenant}/vector-indexes/{index}/jobs/{job_id}

Separate job progress from completed changesA stopped or limited job may have already changed records.

Use the returned job IDIdentify the filtered update or delete.
Inspect state and progressCompare examined, matched and applied work.
Decide whether to continueBase follow-up actions on the reported outcome.

Before you start

Use your database bearer token.

Use the job ID returned by a filtered vector-record update or delete on this index.

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

Check state together with progress. Examined or matched records are not the same as updated records. A stopped or limited job can have applied some changes already.

Response statuses

HTTP status reference

Status	What to do
200	OK
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.
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.

Request example

curl --include --request GET "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/vector-indexes/demo-search/jobs/%3CJOB_ID%3E" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

{
  "job_id": "55555555-5555-4555-8555-555555555555",
  "kind": "update_by_filter",
  "state": "succeeded",
  "namespace_id": "33333333-3333-4333-8333-333333333333",
  "incarnation_id": "66666666-6666-4666-8666-666666666666",
  "restore_epoch": {
    "counter": 0,
    "nonce_prefix": "<opaque-restore-prefix>"
  },
  "created_at": "2026-10-30T00:00:00.000Z",
  "updated_at": "2026-10-30T00:00:00.000Z",
  "progress": {
    "examined": 2,
    "matched": 1,
    "updated": 1
  }
}

{
  "error": {
    "code": "job_not_found",
    "message": "The job was not found.",
    "status": 404,
    "retryable": false
  }
}

Illustrative message; code and envelope follow the documented vector-index contract.

Check the resource ID and API route.

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

HeadersCopy Anchor Link

Read the resultCopy Anchor Link

Response statusesCopy Anchor Link

Before you start

Path parameters

Headers

Read the result

Response statuses