Rename Namespace

Renames a namespace of an index.

1 min read

posthttps://{endpoint}/rename-namespace

curl $UPSTASH_VECTOR_REST_URL/rename-namespace \  -X POST \  -d '{ "namespace": "ns", "newNamespace": "newNs" }' \  -H "Authorization: Bearer $UPSTASH_VECTOR_REST_TOKEN"

{    "result": { "renamed": true }}

posthttps://{endpoint}/rename-namespace

Note

The default namespace, which is the empty string "", cannot be renamed.

Note

There should not be a namespace with the given new namespace name, unless the delete existing flag is passed.

Request#

namespacestringrequired#

The name of the namespace to rename.

newNamespacestringrequired#

The new name of the namespace.

deleteExistingboolean#

When the delete existing flag is passed, if there exists a namespace with the new namespace name, it is deleted before the rename operation.

Default: "false"

Response#

renamedboolean#

Whether the namespace is renamed or not.

Delete Namespace Getting Started