Skip to content

List indexes on table

GET
/dataset-tables/{tableId}/indexes

List all indexes on a dataset table.

tableId
required

Unique identifier of the table to retrieve

string

Unique identifier of the table to retrieve

List of indexes

object
indexes
required

Array of index objects

Array<object>
object
indexId
required

Unique identifier for the index

string
datasetId
required

ID of the parent dataset

string
name
required

Name of the index

string
columnName
required

Column being indexed

string
indexType
required

Type of index (btree, ivf_flat, ivf_pq)

string
status
required

Current index status (pending, building, ready, failed)

string
Allowed values: pending building ready failed stale
errorMessage

Error message if index build failed

string
createdAt
required

When the index was created

string
builtAt

When the index finished building

string

Bad Request - Validation error or invalid input

object
error
required
string
code
string
details
nullable
retryable
boolean

Unauthorized - Authentication required or invalid token

object
error
required
string
code
string
details
nullable
retryable
boolean

Forbidden - Insufficient permissions

object
error
required
string
code
string
details
nullable
retryable
boolean

Not Found - Resource does not exist

object
error
required
string
code
string
details
nullable
retryable
boolean