List index metadata

Tables with the Data API are currently in public preview. Development is ongoing, and the features and functionality are subject to change. Astra DB Serverless, and the use of such, is subject to the DataStax Preview Terms.

Gets information about the indexes associated with a specific table.

Method signature

  • Python

  • TypeScript

  • Java

  • curl

The client does not support this method. Use direct HTTP requests instead, as demonstrated on the curl tab.

The client does not support this method. Use direct HTTP requests instead, as demonstrated on the curl tab.

The client does not support this method. Use direct HTTP requests instead, as demonstrated on the curl tab.

curl -sS -L -X POST "ASTRA_DB_API_ENDPOINT/api/json/v1/ASTRA_DB_KEYSPACE/ASTRA_DB_TABLE" \
--header "Token: ASTRA_DB_APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
  "listIndexes": {
    "options": {
      "explain": true
    }
  }
}'

Result

  • Python

  • TypeScript

  • Java

  • curl

The client does not support this method. Use direct HTTP requests instead, as demonstrated on the curl tab.

The client does not support this method. Use direct HTTP requests instead, as demonstrated on the curl tab.

The client does not support this method. Use direct HTTP requests instead, as demonstrated on the curl tab.

The status.indexes field in the response describes each index in the table.

Example response:

{
  "status": {
    "indexes": [
      {
        "name": "summaryGenresVectorIndex",
        "definition": {
          "column": "summaryGenresVector",
          "options": { "metric": "cosine", "sourceModel": "other" }
        },
        "indexType": "vector"
      },
      {
        "name": "ratingIndex",
        "definition": { "column": "rating", "options": {} },
        "indexType": "regular"
      }
    ]
  }
}

Parameters

  • Python

  • TypeScript

  • Java

  • curl

The client does not support this method. Use direct HTTP requests instead, as demonstrated on the curl tab.

The client does not support this method. Use direct HTTP requests instead, as demonstrated on the curl tab.

The client does not support this method. Use direct HTTP requests instead, as demonstrated on the curl tab.

Name Type Summary

listIndexes

command

The Data API command to get a list of indexes associated with a table in a Serverless (Vector) database.

options.explain

boolean

If true, the response includes index names and metadata. If false or unset, the response includes only index names.

Examples

The following examples demonstrate how to get index metadata for a table.

List index metadata

  • Python

  • TypeScript

  • Java

  • curl

The client does not support this method. Use direct HTTP requests instead, as demonstrated on the curl tab.

The client does not support this method. Use direct HTTP requests instead, as demonstrated on the curl tab.

The client does not support this method. Use direct HTTP requests instead, as demonstrated on the curl tab.

curl -sS -L -X POST "ASTRA_DB_API_ENDPOINT/api/json/v1/ASTRA_DB_KEYSPACE/ASTRA_DB_TABLE" \
--header "Token: ASTRA_DB_APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
  "listIndexes": {
    "options": {
      "explain": true
    }
  }
}'

Client reference

  • Python

  • TypeScript

  • Java

  • curl

The client does not support this method. Use direct HTTP requests instead, as demonstrated on the curl tab.

The client does not support this method. Use direct HTTP requests instead, as demonstrated on the curl tab.

The client does not support this method. Use direct HTTP requests instead, as demonstrated on the curl tab.

Client reference documentation is not applicable for HTTP.

Was this helpful?

Give Feedback

How can we improve the documentation?

© 2025 DataStax | Privacy policy | Terms of use | Manage Privacy Choices

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries. Kubernetes is the registered trademark of the Linux Foundation.

General Inquiries: +1 (650) 389-6000, info@datastax.com