Index Status

Description

The status resource allows you to view the status of the indexing service. You can view the number of users, groups, and search items in both the database (store) and the index. If the database and index do not match, indexing is either in progress or there is a problem with the index. It is recommended that you reindex to correct any issues. If indexing is in progress, you can monitor the status by refreshing the page.

Request parameters

Example usage

The following is a sample request URL used to access the status resource:

1
https://organization.domain.com/context/admin/system/indexer/status?f=pjson

JSON Response examples

The following response is returned while indexing is in progress (when reindexingInProgress is true). When reindexingInProgress is true, any other attempts to run the reindex operation will be blocked and will result in a 500 error.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "indexes": [
    {
      "databaseCount": 4,
      "indexCount": 4,
      "name": "users"
    },
    {
      "databaseCount": 15,
      "indexCount": 0,
      "name": "groups"
    },
    {
      "databaseCount": 650,
      "indexCount": 650,
      "name": "items"
    }
  ],
  "reindexingInProgress": true,
  "syncStatus": false
}

The following sample response is returned when indexing is complete. If the values for all stores are matching after reindexing, the syncStatus property will return as true, otherwise it returns as false.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "indexes": [
    {
      "databaseCount": 4,
      "indexCount": 4,
      "name": "users"
    },
    {
      "databaseCount": 15,
      "indexCount": 15,
      "name": "groups"
    },
    {
      "databaseCount": 650,
      "indexCount": 650,
      "name": "items"
    }
  ],
  "reindexingInProgress": false,
  "syncStatus": true
}