Summary
Check the status of a collection's indexes in Mongo
Description
Check the status of pre-defined indexes for a specific collection.
Route
GET /indexes/:collection/status
Roles
admin
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| collection |
string |
yes |
The name of a collection in Mongo. |
Copied to Clipboard
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
The current statuses of the indexes on the specified collection. |
Copied to Clipboard
{
"missing": [
{
"key": {
"name": 1
},
"background": true,
"name": "name_1",
"unique": true
},
{
"key": {
"name": 1
},
"background": true,
"name": "name_1",
"unique": false
}
],
"misnamed": [
{
"key": {
"name": 1
},
"background": true,
"name": "name_1",
"unique": false
}
],
"external": [
{
"key": {
"name": 1
},
"background": true,
"name": "name_1",
"unique": true
},
{
"key": {
"name": 1
},
"background": true,
"name": "name_1",
"unique": false
},
{
"key": {
"name": 1
},
"background": true,
"name": "name_1",
"unique": true
}
],
"indexed": 27323079,
"total": 1,
"collectionSize": 69120979,
"inProgress": true
}
Copied to Clipboard
{
"title": "result",
"type": "object",
"properties": {
"missing": {
"type": "array",
"items": {
"$ref": "indexes-schema"
}
},
"misnamed": {
"type": "array",
"items": {
"$ref": "indexes-schema"
}
},
"external": {
"type": "array",
"items": {
"$ref": "indexes-schema"
}
},
"indexed": {
"type": "integer",
"minimum": 0
},
"total": {
"$ref": "common-schema#/definitions/total"
},
"collectionSize": {
"type": "integer"
},
"inProgress": {
"type": "boolean"
}
}
}
