Control plane
Configure vector index
Changes the deletion protection or the tags of a vector index.
PATCH /v1/projects/{project_id}/vector-indexes/{index_name}
- Identify the project indexUse the project ID and existing index name.
- Send the changed settingsSupply tags or deletion protection.
- Check the configurationConfirm the response contains the intended settings.
Before you start
Use your organization API key on the control-plane origin.
Use the project ID and index name returned at creation. Dimension and metric cannot be changed.
Path parameters
| Field | Type | Required |
|---|---|---|
project_id | string | Required |
index_name | string | Required |
Request body
application/json
Limits and accepted values
- The JSON body is forwarded unchanged to the instance.
- At least one of deletion_protection (enabled|disabled) or tags is required (400 otherwise).
- Naming any other index field (name, dimension, metric, sparse, text_fields, visibility_fields, embedding, metadata_publish, identifier_profile, index_id, state, score_direction, compat_family, created_at) answers 400 immutable_field;
- any unknown key answers 400.
- A body that is not valid JSON answers 400 before the key is checked.
| Field | Type | Required | Description |
|---|---|---|---|
deletion_protection | string | Optional | — |
tags | object | Optional | Map of tag key (1-80 characters of A-Z, a-z, 0-9, _ and -) to tag value (at most 120 printable ASCII characters). Merged into the existing tags; an empty-string value removes that tag; more than 20 tags after the merge answers 400 and changes nothing. |
Read the result
The response is the index's updated configuration. Check deletion_protection and tags; this operation cannot change the dimension or distance 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. |
| 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. |
| 502 | Check service availability and the write outcome. |
| 503 | Honor Retry-After when present; check write outcomes. |