MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

action=cirrus-check-sanity

(main | cirrus-check-sanity)
  • This module is internal or unstable, and you should not use it. Its operation may change without notice.
  • This module requires read rights.
  • Source: CirrusSearch
  • License: GPL-2.0-or-later

Reports on the correctness of a range of page ids in the search index

Specific parameters:
Other general parameters are available.
cluster

The search cluster to check indices in

One of the following values: default
Default: default
from

Page id to start checking at

This parameter is required.
Type: integer
The value must be no less than 0.
limit

The number of page ids to check

Type: integer or max
The value must be between 1 and 500.
Default: 100
sequenceid

The number of times this set of page ids has been checked

Type: integer
rerenderfrequency

Number of checks after which a page should be rerendered. Based off the provided sequenceid.

Type: integer
The value must be no less than 2.
Default: 16
Example:
Get a report on the correctness of a range of page ids in the search index
api.php?action=cirrus-sanity-check&from=0&limit=100 [open in sandbox]