Skip to main content

Upgrade Project (V2)

This operation updates subscription plan of a specified project.

PATCH/v2/projects/{projectId}/plan
Connection Endpoint

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.

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

The ID of the project to upgrade.

Example Value: proj-xx
Request Bodyapplication/json
planstringrequired

The subscription plan to upgrade to. Possible values are Standard, Enterprise, or BusinessCritical. If you need to upgrade your project to BusinessCritical, please contact us.

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

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

None

A success response

codeinteger

Response code.

Example Value: 0
datastring

A string 'ok' indicating the project is upgraded successfully.

A failure response.

codeinteger

Response code.

messagestring

Error message.

Successjson
{
    "code": 0,
    "data": "ok"
}
Ctrl I