Set namespace capacity

POST /v1/tenants/{tenant}/vector-indexes/{index}/namespaces/configure

Declare a namespace's record capacityRemoving this declaration does not make the database unlimited.

Select the namespaceLocate it inside its vector index.
Set or remove capacitySend a positive declaration, or null to remove it.
Read the saved declarationA value below current usage is rejected.

Before you start

Use your database bearer token.

Use an existing namespace. A declared capacity cannot be smaller than its current usage.

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

declared_capacity must be sent: an integer 1-9007199254740991 sets it, null removes it, absent answers 400.
A value below current usage answers 409.
dry_run: true is refused with 400.
Naming another namespace field answers 400 immutable_field.

Field	Type	Required
`declared_capacity`	`integer`	Optional
`dry_run`	`boolean`	Optional
`name`	`string`	Required

Read the result

Check declared_capacity in the returned namespace. A number sets the declaration and null removes it. This value is not a statement that the database has unlimited capacity.

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 POST "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/vector-indexes/demo-search/namespaces/configure" \
  --header "Authorization: Bearer ${OC_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary '{
  "name": "demo",
  "declared_capacity": 2000
}'

Response example

Examples use synthetic values to show the response format.

Response status

{
  "name": "demo",
  "namespace_id": "33333333-3333-4333-8333-333333333333",
  "state": "active",
  "record_count": 2,
  "pending_records": 0,
  "pending_new_records": 0,
  "dense_ids": 2,
  "sparse_ids": 0,
  "declared_capacity": 2000,
  "position": {
    "domain": "wal",
    "value": "1042:0"
  }
}

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