Upgrade Project (V2)

This operation updates subscription plan of a specified project.

PATCH

/v2/projects/{projectId}

Base URL

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

https://api.cloud.zilliz.com

📘Notes

The endpoints on the control plane currently supports up to 20 requests per second per user per endpoint.

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

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

projectIdstringpathrequired

The ID of the project to upgrade.

Example Value: proj-xx

Request Bodyapplication/json

planstring

The subscription plan to upgrade to.

Possible Values:

StandardEnterprise

export TOKEN="YOUR_API_KEY"
export projectId="proj-xx"

curl --request PATCH \
--url "${BASE_URL}/v2/projects/${projectId}" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "plan": "Enterprise"
}'

Responses200 - application/json

SUCCESS

A success response

codeinteger

Response code.

Example Value: 0

dataobject

Response payload which contains the updated subscription plan of the specified project.

projectIdstring

ID of the upgraded project.

FAILURE

A failure response.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

{
    "code": 0,
    "data": {
        "projectId": "proj-x"
    }
}