Summary
Check the status of multiple collections' indexes in Mongo
Description
Check the status of pre-defined indexes for multiple collections.
Route
GET /indexes/status
Roles
admin
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| queryOptions |
object |
yes |
Options for query parameters. |
Copied to Clipboard
{
"queryOptions": {
"collections": "accounts"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"queryOptions": {
"title": "queryOptions",
"type": "object",
"properties": {
"collections": {
"oneOf": [
{
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"accounts",
"automations"
]
]
},
{
"type": "string",
"examples": [
"accounts"
]
}
]
}
}
}
},
"required": [
"queryOptions"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| results |
object |
The current statuses of the indexes on the specified collections. |
Copied to Clipboard
{
"title": "results",
"type": "object",
"properties": {},
"additionalProperties": {
"title": "result",
"type": "object",
"properties": {
"missing": {
"type": "array",
"items": {
"$ref": "indexes-schema"
}
},
"misnamed": {
"type": "array",
"items": {
"$ref": "indexes-schema"
}
},
"indexed": {
"type": "integer",
"minimum": 0
},
"total": {
"$ref": "common-schema#/definitions/total"
},
"collectionSize": {
"type": "integer"
},
"inProgress": {
"type": "boolean"
}
}
}
}
