List vector indexes

POST /v1/tenants/{tenant}/vector-indexes/list

Discover the vector indexes you can accessExact-name lookup cannot be combined with prefix or cursor.

Choose lookup or browsingRequest one name or a page of names.
Read visible configurationsInspect the indexes the caller may see.
Continue paginated resultsUse the returned cursor for another page.

Before you start

Use your database bearer token.

Path parameters

Field	Type	Required
`tenant`	`string`	Required

Headers

Field	Type	Required	Description
`x-oc-db-user`	`string`	Optional	Acting database user (role, grant and row-policy checks). Send with x-oc-db-key.
`x-oc-db-key`	`string`	Optional	API key of the x-oc-db-user user.

Request body

application/json

Limits and accepted values

name is an exact lookup (no pages, not combinable with prefix or cursor);
prefix is 1-45 bytes of [a-z0-9-];
limit 1-100, default 100.
Send {}
to list everything.

Field	Type	Required
`cursor`	`string`	Optional
`limit`	`integer`	Optional
`name`	`string`	Optional
`prefix`	`string`	Optional

Read the result

indexes contains visible index configurations. Use a returned cursor to continue a paginated request; an exact name lookup is a different form and cannot be mixed with prefix or cursor.

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.
409	Resolve the conflict before retrying.
413	Split or reduce the request body.
415	Send the required Content-Type.
422	Correct the values or unsupported combination.
429	Honor Retry-After when present; back off.
500	Check the outcome before retrying a write.
501	Check deployment support for this operation.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request POST "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/vector-indexes/list" \
  --header "Authorization: Bearer ${OC_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary '{
  "limit": 20
}'

Response example

Examples use synthetic values to show the response format.

Response status

{
  "indexes": [
    {
      "index_id": "22222222-2222-4222-8222-222222222222",
      "name": "demo-search",
      "state": "active",
      "dimension": 3,
      "metric": "cosine",
      "score_direction": "higher_is_better",
      "sparse": false,
      "text_fields": [],
      "visibility_fields": [],
      "embedding": null,
      "deletion_protection": "disabled",
      "tags": {},
      "identifier_profile": "unicode",
      "compat_family": "vectors",
      "created_at": "2026-10-30T00:00:00.000Z"
    }
  ]
}

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

HeadersCopy Anchor Link

Request bodyCopy Anchor Link