---
title: "Get collection index status"
method: GET
path: "/indexes/{collection}/status"
tags: ["Indexes"]
---

# Get collection index status

`GET /indexes/{collection}/status`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/indexes/{collection}/status`
- Auth: none declared

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

## Path parameters

- `collection` string, required

## Response `200`

The current statuses of the indexes on the specified collection.

- IndexesCheckIndexesResponse200
  - `missing` IapIndexesSchema[]
    - `key` object, required
    - `name` string
    - `background` boolean, required
    - `unique` boolean
  - `misnamed` IapIndexesSchema[]
    - `key` object, required
    - `name` string
    - `background` boolean, required
    - `unique` boolean
  - `external` IapIndexesSchema[]
    - `key` object, required
    - `name` string
    - `background` boolean, required
    - `unique` boolean
  - `indexed` integer
  - `total` integer: The total number of documents
  - `collectionSize` integer
  - `inProgress` boolean

## Other responses

- `500`: Error response from API

---

[API](https://skmtc.dev/itential/apis/itential-2.md) - [All operations](https://skmtc.dev/itential/apis/itential-2/llms.txt) - [OpenAPI document](https://skmtc.dev/itential/apis/itential-2/revisions/2095cc90e583?raw)