Skip to main content

List Stages
Private Preview

This operation lists all stages in the specified project. You need to be

GET
/v2/stages
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}}
projectIdstringqueryrequired

The target project of this operation.

Example Value: proj-xxxxxxxxxxxxxxxxx
pageSizeintegerquery

The number of records to include in each response.

Example Value: 10
currentPageintegerquery

The current page number.

Example Value: 1
export TOKEN="YOUR_API_KEY"

curl --request GET \
--url "${BASE_URL}/v2/stages?projectId=proj-xxxxxxxxxxxxxxxxx" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"
Responses200 - application/json

Returns a list of stages.

codeinteger

Response code.

dataobject
countinteger

The total number of stages.

currentPageinteger

The current page number.

pageSizeinteger

The number of records in each response.

stagesarray

The list of stages.

[]stagesobject
stageNamestring

The name of the stage.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 200,
    "data": [
        {
            "stageName": "my_stage_1"
        },
        {
            "stageName": "my_stage_2"
        },
        {
            "stageName": "my_stage_3"
        }
    ]
}