> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.itential.com/itential-platform/2023-2/api-reference/indexes/check-indexes/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itential.com/_mcp/server.

# Get collection index status

GET http://localhost:3000/indexes/{collection}/status

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

Reference: https://docs.itential.com/itential-platform/6/api-reference/indexes/check-indexes

## Authentication

- `Authorization` header (basic auth, required) — Basic authentication of the form `Basic <base64(username:password)>`.

## Request

### Path parameters

- `collection` (string, required) — The name of a collection in Mongo.

## Response

### 200

The current statuses of the indexes on the specified collection.

- `missing` (list of object, optional)
  - `key` (map from string to enum, required)
    - Allowed values: `-1`, `1`
  - `background` (boolean, required)
  - `name` (string, optional)
  - `unique` (boolean, optional)
- `misnamed` (list of object, optional)
  - `key` (map from string to enum, required)
    - Allowed values: `-1`, `1`
  - `background` (boolean, required)
  - `name` (string, optional)
  - `unique` (boolean, optional)
- `external` (list of object, optional)
  - `key` (map from string to enum, required)
    - Allowed values: `-1`, `1`
  - `background` (boolean, required)
  - `name` (string, optional)
  - `unique` (boolean, optional)
- `indexed` (integer, optional)
- `total` (integer, optional) — The total number of documents
- `collectionSize` (integer, optional)
- `inProgress` (boolean, optional)

## Errors

### 500 Internal Server Error

Error response from API

- `any`

## Examples

**Response**

```json
{
  "missing": [
    {
      "key": {
        "name": 1
      },
      "background": true,
      "name": "name_1",
      "unique": true
    }
  ],
  "misnamed": [
    {
      "key": {
        "name": 1
      },
      "background": true,
      "name": "name_1",
      "unique": true
    }
  ],
  "external": [
    {
      "key": {
        "name": 1
      },
      "background": true,
      "name": "name_1",
      "unique": true
    }
  ],
  "indexed": 1,
  "total": 1,
  "collectionSize": 1,
  "inProgress": true
}
```

**SDK Code**

```python
import requests

url = "http://localhost:3000/indexes/collection/status"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'http://localhost:3000/indexes/collection/status';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3000/indexes/collection/status"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/indexes/collection/status")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("http://localhost:3000/indexes/collection/status")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'http://localhost:3000/indexes/collection/status');

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("http://localhost:3000/indexes/collection/status");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:3000/indexes/collection/status")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```