For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Open source Support FAQs Docs Home

Documentation API Reference Release notes

Documentation API Reference Release notes

Introduction
- Overview
- Authentication
Guides
Reference

Open source Support FAQs Docs Home

Reference Indexes

Get collection index status

GET

http://localhost:3000/indexes/:collection/status

GET

/indexes/:collection/status

$ curl http://localhost:3000/indexes/collection/status \
>      -u "<username>:<password>"

1 {
2   "missing": [
3     {
4       "key": {
5         "name": 1
6       },
7       "background": true,
8       "name": "name_1",
9       "unique": true
10     }
11   ],
12   "misnamed": [
13     {
14       "key": {
15         "name": 1
16       },
17       "background": true,
18       "name": "name_1",
19       "unique": true
20     }
21   ],
22   "external": [
23     {
24       "key": {
25         "name": 1
26       },
27       "background": true,
28       "name": "name_1",
29       "unique": true
30     }
31   ],
32   "indexed": 1,
33   "total": 1,
34   "collectionSize": 1,
35   "inProgress": true
36 }

Checks the status of pre-defined indexes for a specific collection.

Was this page helpful?

Get index status for all collections

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

collectionstringRequired

The name of a collection in Mongo.

Response

The current statuses of the indexes on the specified collection.

missinglist of objects

misnamedlist of objects

externallist of objects

indexedinteger>=0

totalinteger>=0

The total number of documents

collectionSizeinteger

inProgressboolean

Errors

500

Internal Server Error