Update a vector index

PATCH /v1/tenants/{tenant}/vector-indexes/{index}

Update tags or deletion protectionTags merge; an empty-string value removes that tag.

Select an existing indexUse its name or ID in this tenant.
Supply editable settingsChange tags or the deletion-protection flag.
Review the saved settingsDimensions and metric are unchanged.

Before you start

Use your database bearer token.

Use the existing index's name or ID. Only tags and deletion protection can change; dimension and metric stay fixed.

Path parameters

Field	Type	Required
`tenant`	`string`	Required
`index`	`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.

Request body

application/json

Limits and accepted values

At least one field is required.
deletion_protection: enabled|disabled.
tags merge into the existing tags and an empty-string value removes a tag;
at most 20 after the merge.
Naming any other index field answers 400 immutable_field.

Field	Type	Required
`deletion_protection`	`string`	Optional
`tags`	`object`	Optional

Read the result

The response shows the updated index configuration. Tags are merged; an empty-string tag value removes that tag. Changing tags or deletion protection does not change the index's dimensions or metric.

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.
409	Resolve the conflict before retrying.
413	Split or reduce the request body.
415	Send the required Content-Type.
422	Correct the values or unsupported combination.
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 PATCH "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/vector-indexes/demo-search" \
  --header "Authorization: Bearer ${OC_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary '{
  "tags": {
    "environment": "docs"
  }
}'

Response example

Examples use synthetic values to show the response format.

Response status

{
  "index_id": "22222222-2222-4222-8222-222222222222",
  "name": "demo-search",
  "state": "active",
  "dimension": 3,
  "metric": "cosine",
  "score_direction": "higher_is_better",
  "sparse": false,
  "text_fields": [],
  "visibility_fields": [],
  "embedding": null,
  "deletion_protection": "disabled",
  "tags": {
    "environment": "docs"
  },
  "identifier_profile": "unicode",
  "compat_family": "vectors",
  "created_at": "2026-10-30T00:00:00.000Z"
}

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

HeadersCopy Anchor Link

Request bodyCopy Anchor Link