Create Free Cluster

Create free cluster. Currently, you can create a free cluster on Zilliz Cloud. For the number of clusters that can be created, please refer to the Zilliz Cloud Limits.

POST

/v2/clusters/createFree

Base URL

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

https://api.cloud.zilliz.com

export BASE_URL="https://api.cloud.zilliz.com"

Parameters

Authorizationstringheaderrequired

The authentication token should be an API key with appropriate privileges.

Example Value: Bearer {{TOKEN}}

Acceptstringheader

Use application/json.

Example Value: application/json

Request Bodyapplication/json

clusterNamestringrequired

Name of the cluster to create.

projectIdstringrequired

ID of the project to which the cluster belongs.

Example Value: proj-xxxxxxxxxxxxxxxxxxxx

regionIdstringrequired

ID of the cloud region hosting the cluster.

export TOKEN="YOUR_API_KEY"

curl --request POST \
--url "${BASE_URL}/v2/clusters/createFree" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
-d '{
    "clusterName": "Free-01",
    "projectId": "proj-xxxxxxxxxxxxxxxxxxxxxx",
    "regionId": "gcp-us-west1"
}'

Responses200 - application/json

SUCCESS

codeinteger

Response code.

dataobject

Response payload.

clusterIdstring

ID of the cluster created.

usernamestring

Name of the cluster administration user.

passwordstring

Password of the cluster administration user. The password will not be displayed again. Please note it down and securely store it.

promptstring

Prompt messages returned.

FAILURE

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

{
    "code": 0,
    "data": {
        "clusterId": "inxx-xxxxxxxxxxxxxxx",
        "username": "db_xxxxxxxx",
        "password": "*************",
        "prompt": "successfully submitted, cluster is being created. You can access data about the creation progress and status of your cluster by DescribeCluster API. Once the cluster status is RUNNING, you may access your vector database using the SDK with the admin account and the initial password you specified."
    }
}