Skip to main content
POST
Describe Index
Get detailed information about an existing index.

Authentication

Required - API key via X-API-Key header:
You can get an API key from the CyborgDB Admin Dashboard. For more info, follow this guide.

Request Body

Response

v0.17 simplified the describe response. The index_type and nested index_config fields from v0.16 are gone — there is now a single DiskIVF index type and the relevant parameters are returned as top-level fields.

Exceptions

  • 401: Authentication failed (invalid API key) or wrong index_key on SDK-supplied indexes — see error model
  • 404: Index not found
  • 422: Invalid request parameters
  • 500: Internal server error

Example Usage

KMS-backed index (no key required):