Skip to main content
POST
/
v1
/
table
/
{id}
/
index
/
list
List indexes on a table
curl --request POST \
  --url {scheme}://{host}:{port}/{basePath}/v1/table/{id}/index/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": [
    "<string>"
  ],
  "version": 1,
  "page_token": "<string>",
  "limit": 123
}
'
{
  "indexes": [
    {
      "index_name": "<string>",
      "index_uuid": "<string>",
      "columns": [
        "<string>"
      ],
      "status": "<string>"
    }
  ],
  "page_token": "<string>"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
id
string
required

string identifier of an object in a namespace, following the Lance Namespace spec. When the value is equal to the delimiter, it represents the root namespace. For example, v1/namespace/$/list performs a ListNamespace on the root namespace.

Query Parameters

​
delimiter
string

An optional delimiter of the string identifier, following the Lance Namespace spec. When not specified, the $ delimiter must be used.

Body

application/json

Index list request

​
id
string[]

The namespace identifier

​
version
integer<int64> | null

Optional table version to list indexes from

Required range: x >= 0
​
page_token
string | null

An opaque token that allows pagination for list operations (e.g. ListNamespaces).

For an initial request of a list operation, if the implementation cannot return all items in one response, or if there are more items than the page limit specified in the request, the implementation must return a page token in the response, indicating there are more results available.

After the initial request, the value of the page token from each response must be used as the page token value for the next request.

Caller must interpret either null, missing value or empty string value of the page token from the implementation's response as the end of the listing results.

​
limit
integer | null

An inclusive upper bound of the number of results that a caller will receive.

Response

List of indices on the table

​
indexes
object[]
required

List of indexes on the table

​
page_token
string | null

An opaque token that allows pagination for list operations (e.g. ListNamespaces).

For an initial request of a list operation, if the implementation cannot return all items in one response, or if there are more items than the page limit specified in the request, the implementation must return a page token in the response, indicating there are more results available.

After the initial request, the value of the page token from each response must be used as the page token value for the next request.

Caller must interpret either null, missing value or empty string value of the page token from the implementation's response as the end of the listing results.