Drop Database Properties

This operation drops the specified properties of the specified database.

POST

/v2/vectordb/databases/drop_properties

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 On 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

dbNamestringrequired

The name of the target database.

propertyKeysarrayrequired

The names of the properties to be dropped.

[]propertyKeysstring

The name of a property to be dropped.

Possible Values:

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/databases/drop_properties" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "dbName": "my_database",
    "propertyKeys": [
        "database.replica.number"
    ]
}'

Responses200 - application/json

SUCCESS

codeinteger

Response code.

dataobject

An empty response.

FAILURE

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

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