Skip to main content

Create Stage
Private Preview

This operation creates a new stage in the specified project.

POST
/v2/stages/create
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.

This endpoint is currently in Public Preview. If you have encountered any issue related to this endpoint, please contact Zilliz Cloud support.

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}}
Request Bodyapplication/json
projectIdstringrequired

The ID of the project to which the stage belongs.

Example Value: proj-xxxxxxxxxxxxxxxxxxxxxxx
regionIdstringrequired

The ID of the region where the stage will be created. You can use List Cloud Regions to list available regions.

stageNamestringrequired

The name of the stage to create.

export TOKEN="YOUR_API_KEY"

curl --request POST \
--url "${BASE_URL}/v2/stages/create" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "projectId": "proj-xxxxxxxxxxxxxxxxxxxxxxx",
    "regionId": "us-west-1",
    "stageName": "my_stage"
}'
Responses200 - application/json

Returns a list of stages.

codeinteger

Response code.

dataobject
stageNamestring

The name of the created stage.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 0,
    "data": {
        "stageName": "mysql-stage"
    }
}