Skip to main content

List Projects

List all projects scoped to API-Key.

GET
/v2/projects
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
export TOKEN="YOUR_API_KEY"

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

Response code.

dataarray

Response payload, which is a list of projects in detail.

[]dataobject

List of projects in detail.

projectIdstring

ID of a project.

projectNamestring

Name of a project.

instanceCountstring

Number of clusters in the projects.

createTimestring

Time at which the project is created.

A failure response.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 0,
    "data": [
        {
            "projectName": "Default Project",
            "projectId": "proj-xxxxxxxxxxxxxxxxxxxxxxx",
            "instanceCount": 2,
            "createTime": "2023-08-16T07:34:06Z"
        }
    ]
}