Delete a vector namespace

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

Remove a named vector namespaceThe reserved default namespace cannot be deleted this way.

Verify the namespaceCheck the parent index and exact namespace name.
Confirm that same nameSupply the matching confirmation value.
Follow background removalThe deleting state means erasure is underway.

Before you start

Use your database bearer token.

Set confirm to the exact namespace name. The reserved __default__ namespace cannot be deleted.

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

confirm must equal name (400 otherwise).
__default__ cannot be deleted;
clear it with a delete-all instead.
dry_run: true is refused with 400.

Field	Type	Required
`confirm`	`string`	Optional
`dry_run`	`boolean`	Optional
`name`	`string`	Required

Read the result

state: deleting means the namespace is being removed in the background. Check the name and matching confirm value before sending; the reserved default namespace cannot be deleted this way.

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.
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/delete" \
  --header "Authorization: Bearer ${OC_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary '{
  "name": "demo",
  "confirm": "demo"
}'

Response example

Examples use synthetic values to show the response format.

Response status

{
  "namespace_id": "33333333-3333-4333-8333-333333333333",
  "state": "deleting",
  "receipt": {
    "tenant": "your-tenant",
    "index_id": "22222222-2222-4222-8222-222222222222",
    "namespace_id": "33333333-3333-4333-8333-333333333333",
    "incarnation_id": "66666666-6666-4666-8666-666666666666",
    "restore_epoch": {
      "counter": 0,
      "nonce_prefix": "<opaque-restore-prefix>"
    },
    "position": {
      "domain": "wal",
      "value": "1042:0"
    },
    "durability_scope": "local_fsync",
    "records": []
  }
}

Accepted deletion; the receipt lists no individual records.

{
  "error": {
    "code": "namespace_reserved",
    "message": "The default namespace cannot be deleted.",
    "status": 400,
    "retryable": false
  }
}

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

Correct the request before retrying.

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