Control plane
List project vector indexes
Lists the vector indexes in a project, in ascending name order, one page at a time.
GET /v1/projects/{project_id}/vector-indexes
- Select the projectOptionally narrow index names by prefix.
- Read one pageInspect index IDs, configurations and states.
- Continue with the cursorKeep the same project and filters for the next page.
Before you start
Use your organization API key on the control-plane origin.
Use the project ID whose vector indexes you want to list.
Path parameters
| Field | Type | Required |
|---|---|---|
project_id | string | Required |
Query parameters
| Field | Type | Required |
|---|---|---|
limit | integer | Optional |
cursor | string | Optional |
prefix | string | Optional |
Read the result
Each item in indexes contains the index ID, configuration and state. This operation returns one page; use a returned cursor for the next page rather than treating the first page as the complete inventory.
Response statuses
HTTP status reference
| Status | What to do |
|---|---|
| 200 | OK |
| 400 | Correct the request before retrying. |
| 401 | Check the credential and Authorization header. |
| 402 | Check feature access or available credits. |
| 403 | Check tenant access, roles and permissions. |
| 404 | Check the resource ID and API route. |
| 429 | Honor Retry-After when present; back off. |
| 500 | Check the outcome before retrying a write. |
| 501 | Check deployment support for this operation. |
| 502 | Check service availability and the write outcome. |
| 503 | Honor Retry-After when present; check write outcomes. |