Skip to main content

RESTful API Overview

Zilliz Cloud offers RESTful APIs for you to manipulate your clusters, collections, and data stored in them.

Zilliz Cloud uses the control plane to centralize the management of clusters and related resources, while the data plane is responsible for data storage and processing within a specific collection.

Note

When performing operations with the RESTful APIs, you can use either of the following methods to authenticate:

  • Using an API key

    To obtain an API key, follow the instructions in the API keys.

  • Using a cluster token

    To obtain a cluster token, use a colon (:) to join the username and password of the target cluster, like username:password. Note that this is the only valid authentication method for BYOC clusters.

  • When using the Control Plane APIs, you need to use a valid API key to authenticate your requests.

    The following is an example of listing all the available cloud providers.

    export API_KEY="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

    curl --request GET \
        --url "https://api.cloud.zilliz.com/v2/clouds" \
        --header "Authorization: Bearer ${API_KEY}" \
        --header "accept: application/json" \
        --header "content-type: application/json"

  • When using the Data Plane APIs, you can use either a valid API key or a valid pair of cluster username and password to authenticate your requests.

    The following is an example of listing all the available collections in the specified cluster.

    export CLUSTER_ENDPOINT="YOUR_CLUSTER_ENDPOINT"
    export TOKEN="db_admin:xxxxxxxxxxxx"

    curl --request GET \
        --url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/list" \
        --header "Authorization: Bearer ${TOKEN}" \
        --header "accept: application/json" \
        --header "content-type: application/json" \
        -d '{}'