List index names (HTTP)

For details about additional languages, see:

Gets the names of the indexes for a table.

Ready to write code? See the examples for this method to get started.

Result

Returns the index names for a table as an unordered list of strings in the status.indexes field of the response.

Example response:

{
  "status": {
    "indexes": [
      "index_name_1",
      "index_name_2"
    ]
  }
}

Parameters

Use the listIndexes command.

Command signature

curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME/TABLE_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
  "listIndexes": {
    "options": {
      "explain": false
    }
  }
}'

Name Type Summary

Name	Type	Summary
`options.explain`	`false`	Must be `false` to return only the index names. Otherwise, index names and metadata are returned.

options.explain

false

Must be false to return only the index names. Otherwise, index names and metadata are returned.

Examples

The following examples demonstrate how to get the names of the indexes for a table.

List index names

curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME/TABLE_NAME" \
  --header "Token: APPLICATION_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "listIndexes": {
    "options": {
      "explain": false
    }
  }
}'

List index names (HTTP)

Result

Parameters

Examples

List index names

Was this helpful?

Give Feedback