MAmacrometa
Indexes

Read index

Fetch the information about index.

get/_fabric/{fabric}/_api/index/{collection}/{indexName}

Request

Path parameters

fabricstring string required

The name of the fabric.

collectionstring string required

The collection name.

indexNamestring string required

The name of the index.

Response

Successfully fetched index information.

codeinteger

HTTP response code.

errorboolean

Flag if there is an error in response. False for this response.

fieldsstring[]

Array of fields on which index is created.

idstring

Index identifier.

namestring

Name of the index.

selectivityEstimatenumber

The selectivity estimate of index.

sparseboolean

True if index is sparse type.

typestring

Index type.

uniqueboolean

True if index is unique.

expireAfternumber

Index expiry time.

Example response

{
  "code": 200,
  "fields": [
    "_key"
  ],
  "id": "61862387",
  "name": "idx_1723573111790501888",
  "selectivityEstimate": 1,
  "type": "fulltext",
  "unique": true,
  "expireAfter": 3600
}

Changes

No recorded changes to this operation across all 1 revision of this API.