Skip to main content

Drop Alias

This operation drops a specified alias.

POST
/v2/vectordb/aliases/drop
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 should be an API key with appropriate privileges or a pair of colon-joined username and password, like username:password.

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

The name of the database to which the collection belongs.

collectionNamestring

The name of the collection to which the alias is assigned to.

aliasNamestringrequired

The alias to drop. When dropping an alias, you do not need to provide the collection name because one alias can only be assigned to exactly one collection. Therefore, the server knows which collection the specified alias belongs to.

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/aliases/drop" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "aliasName": "bob"
}'
Responses200 - application/json

A success response

codeinteger

Response code.

Example Value: 0
dataobject

Response payload which is an empty object.

codeinteger

Response code.

messagestring

Error message.

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