List Projects

Lists existing projects.

GET

/v1/projects

Base URL

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

https://controller.api.${CLOUD_REGION}.zillizcloud.com

📘Notes

• You need to replace ${CLOUD_REGION} with the appropriate region for your deployment.
• To get the cloud region ID, refer to On Zilliz Cloud Console or List Cloud Regions.

export CLOUD_REGION="gcp-us-west1"
export BASE_URL="https://controller.api.${CLOUD_REGION}.zillizcloud.com"

Parameters

Authorizationstringheaderrequired

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

Example Value: Bearer {{TOKEN}}

export TOKEN="YOUR_API_KEY"

curl --request GET \
--url "${BASE_URL}/v1/projects" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"

Responses200 - application/json

SUCCESS

Returns a list of projects.

codeinteger

Response code.

dataarray

Response payload, which is a list of projects.

[]dataobject

A project.

createTimeMillistring

A numeric value representing the creation time of the project in milliseconds since the Unix epoch.

instanceCountinteger

The number of clusters created in the project.

projectIdstring

The ID of the project.

projectNamestring

The name of the project.

FAILURE

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

{
    "code": 200,
    "data": [
        {
            "createTimeMilli": 1685006864000,
            "instanceCount": 0,
            "projectId": "proj-xxxxxxxxxxxxxxxxxxxxxx",
            "projectName": "Default Project"
        }
    ]
}