# Describe index

Inspect index configuration and build state.

SDK: `@zilliz/milvus2-sdk-node@3.0.10` · Tested with Milvus 3.0.6

Canonical documentation: https://milvus-io.github.io/milvus-sdk-node/rest-api/indexes/describe/

## Section links

- [cURL command](https://milvus-io.github.io/milvus-sdk-node/rest-api/indexes/describe/#curl-command)
- [Default request](https://milvus-io.github.io/milvus-sdk-node/rest-api/indexes/describe/#default-request)
- [Sample response](https://milvus-io.github.io/milvus-sdk-node/rest-api/indexes/describe/#sample-response)
- [Request fields](https://milvus-io.github.io/milvus-sdk-node/rest-api/indexes/describe/#request-fields)

`POST /v2/vectordb/indexes/describe`

Replace `https://your-cluster.example.com` with your Milvus endpoint. Set `MILVUS_TOKEN` for authentication or omit the Authorization header on an unauthenticated cluster.

## cURL command

```bash
curl --request POST --url 'https://your-cluster.example.com/v2/vectordb/indexes/describe' \
  --header 'Content-Type: application/json' \
  --header "Authorization: Bearer ${MILVUS_TOKEN}" \
  --data-raw '{
  "dbName": "default",
  "collectionName": "books",
  "indexName": "vector_idx"
}'
```

## Default request

```json
{
  "dbName": "default",
  "collectionName": "books",
  "indexName": "vector_idx"
}
```

## Sample response

```json
{
  "code": 0,
  "data": [
    {
      "indexName": "vector_idx",
      "fieldName": "vector",
      "indexState": "Finished",
      "totalRows": 1,
      "pendingRows": 0,
      "indexedRows": 1,
      "failReason": "",
      "indexParams": [
        {
          "key": "index_type",
          "value": "AUTOINDEX"
        },
        {
          "key": "metric_type",
          "value": "COSINE"
        }
      ]
    }
  ]
}
```

## Request fields

- `dbName` string
  Database name. Operations on collections use default when omitted.
- `collectionName` string (required)
  Name of the collection.
- `indexName` string (required)
  Name of the index on the collection.
- `timestamp` integer
  Timestamp for the index description, when needed.

See [`HttpClient.describeIndex`](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#describeindex) for the Node.js SDK method.
