List indexes on a table

List all indices created on a table. Returns information about each index including name, columns, status, and UUID.

post/v1/table/{id}/index/list

Path parameters

idstring 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

delimiterstring

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

Request body

{"stackTrail":"components:schemas:ListTableIndicesRequest:properties:context","oasType":"schema","type":"unknown","description":"Arbitrary context as key-value pairs.\nHow to use the context is custom to the specific implementation.\n\nOn a request, it carries caller-provided context to the implementation.\nOn a response, it carries implementation-provided context back to the caller.\n\nREST NAMESPACE ONLY\nContext entries are mapped to and from HTTP headers using the `header.` prefix:\n- On a request, any entry whose key starts with `header.` is sent as an HTTP\n request header with the prefix stripped. For example, the entry\n `{\"header.Authorization\": \"Bearer abc\"}` is sent as the request header\n `Authorization: Bearer abc`.\n- On a response, every HTTP response header is returned as an entry whose key is the\n header name prefixed with `header.`. For example, the response header\n `x-request-id: abc123` is returned as the entry `{\"header.x-request-id\": \"abc123\"}`.\n"}

idstring[]

The namespace identifier

versioninteger nullable

Optional table version to list indexes from

branchstring

Branch to target. When not specified, the main branch is used.

page_tokenstring nullable

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.

limitinteger nullable

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

Example request

{
  "identity": {
    "api_key": "api_key",
    "auth_token": "auth_token"
  },
  "context": {
    "key": "context"
  },
  "page_token": "page_token",
  "limit": 6,
  "id": [
    "id",
    "id"
  ],
  "version": 0,
  "branch": "branch"
}

Response

List of indices on the table

{"stackTrail":"components:schemas:ListTableIndicesResponse:properties:context","oasType":"schema","type":"unknown","description":"Arbitrary context as key-value pairs.\nHow to use the context is custom to the specific implementation.\n\nOn a request, it carries caller-provided context to the implementation.\nOn a response, it carries implementation-provided context back to the caller.\n\nREST NAMESPACE ONLY\nContext entries are mapped to and from HTTP headers using the `header.` prefix:\n- On a request, any entry whose key starts with `header.` is sent as an HTTP\n request header with the prefix stripped. For example, the entry\n `{\"header.Authorization\": \"Bearer abc\"}` is sent as the request header\n `Authorization: Bearer abc`.\n- On a response, every HTTP response header is returned as an entry whose key is the\n header name prefixed with `header.`. For example, the response header\n `x-request-id: abc123` is returned as the entry `{\"header.x-request-id\": \"abc123\"}`.\n"}

page_tokenstring nullable

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

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.

Example response

{
  "indexes": [
    {
      "index_uuid": "index_uuid",
      "size_bytes": 0,
      "columns": [
        "columns",
        "columns"
      ],
      "created_at": "2000-01-23T04:56:07.000+00:00",
      "index_details": "index_details",
      "num_indexed_rows": 0,
      "num_segments": 0,
      "index_type": "index_type",
      "index_version": 0,
      "num_unindexed_rows": 0,
      "index_name": "index_name",
      "status": "status",
      "type_url": "type_url"
    },
    {
      "index_uuid": "index_uuid",
      "size_bytes": 0,
      "columns": [
        "columns",
        "columns"
      ],
      "created_at": "2000-01-23T04:56:07.000+00:00",
      "index_details": "index_details",
      "num_indexed_rows": 0,
      "num_segments": 0,
      "index_type": "index_type",
      "index_version": 0,
      "num_unindexed_rows": 0,
      "index_name": "index_name",
      "status": "status",
      "type_url": "type_url"
    }
  ],
  "context": {
    "key": "context"
  },
  "page_token": "page_token"
}

Changes

Changed in 12 of the 55 revisions of this API.245171

Jul 1, 2026591cd95574b07See the full diff
- ○
  added the optional property context to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property context to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property context to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property context to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property context to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property context to the response with the 503 status
  response-optional-property-added
- ○
  added the optional property context to the response with the 5XX status
  response-optional-property-added
Jun 9, 202618253b7d5e1c9See the full diff
- ○
  added the optional property indexes/items/created_at to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property indexes/items/index_details to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property indexes/items/index_type to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property indexes/items/index_version to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property indexes/items/num_indexed_rows to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property indexes/items/num_segments to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property indexes/items/num_unindexed_rows to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property indexes/items/size_bytes to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property indexes/items/type_url to the response with the 200 status
  response-optional-property-added
Jun 5, 20269932582b6bd71See the full diff
- ○
  added the new optional request property branch
  new-optional-request-property
Jan 2, 202683f8516f05071See the full diff
- ○
  added the new optional request property context
  new-optional-request-property
Jan 1, 2026c987c26ccb0f1See the full diff
- ○
  added the new optional request property identity
  new-optional-request-property
Dec 20, 20255d6099d672d3666See the full diff
- ▲
  the code response property's min was decreased from 400.00 to 0.00 for the response status 400
  response-property-min-decreased
- ▲
  the code response property's min was decreased from 400.00 to 0.00 for the response status 401
  response-property-min-decreased
- ▲
  the code response property's min was decreased from 400.00 to 0.00 for the response status 403
  response-property-min-decreased
- ▲
  the code response property's min was decreased from 400.00 to 0.00 for the response status 404
  response-property-min-decreased
- ▲
  the code response property's min was decreased from 400.00 to 0.00 for the response status 503
  response-property-min-decreased
- ▲
  the code response property's min was decreased from 400.00 to 0.00 for the response status 5XX
  response-property-min-decreased
- ●
  removed the optional property type from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property type from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property type from the response with the 403 status
  response-optional-property-removed
- ●
  removed the optional property type from the response with the 404 status
  response-optional-property-removed
- ●
  removed the optional property type from the response with the 503 status
  response-optional-property-removed
- ●
  removed the optional property type from the response with the 5XX status
  response-optional-property-removed
- ○
  the response property code became required for the status 400
  response-property-became-required
- ○
  the response property code became required for the status 401
  response-property-became-required
- ○
  the response property code became required for the status 403
  response-property-became-required
- ○
  the response property code became required for the status 404
  response-property-became-required
- ○
  the response property code became required for the status 503
  response-property-became-required
- ○
  the response property code became required for the status 5XX
  response-property-became-required
Aug 2, 202589fbd62726463See the full diff
- ○
  added the new optional request property limit
  new-optional-request-property
- ○
  added the new optional request property page_token
  new-optional-request-property
- ○
  added the optional property page_token to the response with the 200 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 29, 202540a3bc489d4661212See the full diff
- ▲
  the response property type became optional for the status 400
  response-property-became-optional
- ▲
  the response property type became optional for the status 401
  response-property-became-optional
- ▲
  the response property type became optional for the status 403
  response-property-became-optional
- ▲
  the response property type became optional for the status 404
  response-property-became-optional
- ▲
  the response property type became optional for the status 503
  response-property-became-optional
- ▲
  the response property type became optional for the status 5XX
  response-property-became-optional
- ●
  removed the optional property status from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property status from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property status from the response with the 403 status
  response-optional-property-removed
- ●
  removed the optional property status from the response with the 404 status
  response-optional-property-removed
- ●
  removed the optional property status from the response with the 503 status
  response-optional-property-removed
- ●
  removed the optional property status from the response with the 5XX status
  response-optional-property-removed
- ●
  removed the optional property title from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property title from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property title from the response with the 403 status
  response-optional-property-removed
- ●
  removed the optional property title from the response with the 404 status
  response-optional-property-removed
- ●
  removed the optional property title from the response with the 503 status
  response-optional-property-removed
- ●
  removed the optional property title from the response with the 5XX status
  response-optional-property-removed
- ○
  added the optional property code to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property code to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property code to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property code to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property code to the response with the 503 status
  response-optional-property-added
- ○
  added the optional property code to the response with the 5XX status
  response-optional-property-added
- ○
  added the optional property error to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property error to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property error to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property error to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property error to the response with the 503 status
  response-optional-property-added
- ○
  added the optional property error to the response with the 5XX status
  response-optional-property-added
Jul 25, 20258769f8e36bc4331See the full diff
- ▲
  removed the required property location from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property name from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property namespace from the response with the 200 status
  response-required-property-removed
- ●
  removed the request property name
  request-property-removed
- ●
  removed the request property namespace
  request-property-removed
- ●
  removed the optional property properties from the response with the 200 status
  response-optional-property-removed
- ○
  added the new optional request property id
  new-optional-request-property
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 22, 2025ac7519693c523See the full diff
- ○
  api tag Index added
  api-tag-added
- ○
  added the new optional query request parameter delimiter to all path's operations
  new-optional-request-default-parameter-to-existing-path
- ○
  added the new optional query request parameter delimiter
  new-optional-request-parameter
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history (12 revisions)