Describe an index

Get metadata of an existing index.

GET /projects/{projectId}/indexes/{indexName}

cURL

cURL

curl --request GET \
  --url https://{baseUrl}/{version}/projects/{projectId}/indexes/{indexName} \
  --header 'content-type: <content-type>' \
  --header 'x-api-key: <x-api-key>'

200

{
  "projectId": "<string>",
  "indexName": "<string>",
  "mappings": {},
  "numDocs": 123,
  "cloneSourceInfo": {
    "sourceProjectId": "<string>",
    "sourceIndexName": "<string>",
    "sourceIndexVersionId": "<string>"
  },
  "indexStatus": "CREATING",
  "indexClass": "STANDARD"
}

Headers

content-type · string · default: application/json · required

x-api-key · string · required

Project API Key.

Path Parameters

projectId · string · required

Project ID.

indexName · string · required

Index name.

Response

200 - application/json

Describe index success.

projectId · string

Project ID.

indexName · string

Index name.

mappings · object

Show child attributes

numDocs · integer

Total number of documents.

cloneSourceInfo · object

Clone source information.

Show child attributes

indexStatus · enum<string>

Status

Available options: CREATING, ACTIVE, DELETING

indexClass · enum<string> · default: STANDARD

Index class.

Available options: STANDARD, INFREQUENT_ACCESS