Skip to main content

Rename Collection

This operation renames an existing collection.

POST
/v2/vectordb/collections/rename
Cluster Endpoint

The base URL for this API is in the following format:

https://${CLUSTER_ENDPOINT}

📘Notes
  • You need to fill in ${CLUSTER_ENDPOINT} with that of your Zilliz Cloud cluster.
  • To get the endpoint, refer to Zilliz Cloud Console or use the Describe Cluster V2 API to extract the values from the responses.
export CLUSTER_ENDPOINT=""
Parameters
Authorizationstringheaderrequired

The authentication token

Example Value: Bearer {{TOKEN}}
Request Bodyapplication/json
collectionNamestringrequired

The name of the target collection. Setting this to a non-existing collection results in an error.

dbNamestring

The name of the database that to which the collection belongs . Setting this to a non-existing database results in an error.

newCollectionNamestringrequired

The name of the target collection after this operation. Setting this to the value of oldcollectionname results in an error.

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/rename" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "test_collection",
    "newCollectionName": "quick_setup"
}'
Responses200 - application/json

A success response

codeinteger

Response code.

Example Value: 0
dataobject

Response payload which is an empty object.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 0,
    "data": {}
}